blob: 98ffba1c8f49c092d8383370bb9ad2a53852ea5d [file] [log] [blame]
Eino-Ville Talvalab2675542012-12-12 13:29:45 -08001/*
2 * Copyright (C) 2013 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Eino-Ville Talvala2f1a2e42013-07-25 17:12:05 -070017package android.hardware.camera2;
Eino-Ville Talvalab2675542012-12-12 13:29:45 -080018
Igor Murashkincc542a42014-06-25 11:52:23 -070019import android.hardware.camera2.impl.CameraMetadataNative;
Igor Murashkin6c76f582014-07-15 17:19:49 -070020import android.hardware.camera2.impl.PublicKey;
21import android.hardware.camera2.impl.SyntheticKey;
Igor Murashkind6d65152014-05-19 16:31:02 -070022import android.util.Log;
Eino-Ville Talvalab2675542012-12-12 13:29:45 -080023
Igor Murashkin7a36a0f2013-09-10 18:13:09 -070024import java.lang.reflect.Field;
Igor Murashkin03fdb142013-09-30 12:14:58 -070025import java.lang.reflect.Modifier;
Igor Murashkin7a36a0f2013-09-10 18:13:09 -070026import java.util.ArrayList;
Igor Murashkincc542a42014-06-25 11:52:23 -070027import java.util.Arrays;
Igor Murashkin7a36a0f2013-09-10 18:13:09 -070028import java.util.Collections;
29import java.util.List;
30
Eino-Ville Talvalab2675542012-12-12 13:29:45 -080031/**
32 * The base class for camera controls and information.
33 *
Igor Murashkin7a36a0f2013-09-10 18:13:09 -070034 * <p>
Eino-Ville Talvalab2675542012-12-12 13:29:45 -080035 * This class defines the basic key/value map used for querying for camera
36 * characteristics or capture results, and for setting camera request
37 * parameters.
Igor Murashkin7a36a0f2013-09-10 18:13:09 -070038 * </p>
39 *
40 * <p>
41 * All instances of CameraMetadata are immutable. The list of keys with {@link #getKeys()}
Igor Murashkind6d65152014-05-19 16:31:02 -070042 * never changes, nor do the values returned by any key with {@code #get} throughout
Igor Murashkin7a36a0f2013-09-10 18:13:09 -070043 * the lifetime of the object.
44 * </p>
Eino-Ville Talvalab2675542012-12-12 13:29:45 -080045 *
46 * @see CameraDevice
47 * @see CameraManager
Igor Murashkin68f40062013-09-10 12:15:54 -070048 * @see CameraCharacteristics
Eino-Ville Talvalab2675542012-12-12 13:29:45 -080049 **/
Igor Murashkind6d65152014-05-19 16:31:02 -070050public abstract class CameraMetadata<TKey> {
51
52 private static final String TAG = "CameraMetadataAb";
Igor Murashkin696bbee2014-08-07 18:02:51 -070053 private static final boolean VERBOSE = Log.isLoggable(TAG, Log.VERBOSE);
Igor Murashkin70725502013-06-25 20:27:06 +000054
Eino-Ville Talvalab2675542012-12-12 13:29:45 -080055 /**
Igor Murashkin68f40062013-09-10 12:15:54 -070056 * Set a camera metadata field to a value. The field definitions can be
57 * found in {@link CameraCharacteristics}, {@link CaptureResult}, and
58 * {@link CaptureRequest}.
59 *
60 * @param key The metadata field to write.
61 * @param value The value to set the field to, which must be of a matching
62 * type to the key.
63 *
Eino-Ville Talvala70c22072013-08-27 12:09:04 -070064 * @hide
Eino-Ville Talvalab2675542012-12-12 13:29:45 -080065 */
Eino-Ville Talvala70c22072013-08-27 12:09:04 -070066 protected CameraMetadata() {
Eino-Ville Talvalab2675542012-12-12 13:29:45 -080067 }
68
69 /**
Igor Murashkin7a36a0f2013-09-10 18:13:09 -070070 * Get a camera metadata field value.
71 *
72 * <p>The field definitions can be
Igor Murashkin68f40062013-09-10 12:15:54 -070073 * found in {@link CameraCharacteristics}, {@link CaptureResult}, and
Igor Murashkin7a36a0f2013-09-10 18:13:09 -070074 * {@link CaptureRequest}.</p>
75 *
76 * <p>Querying the value for the same key more than once will return a value
77 * which is equal to the previous queried value.</p>
Eino-Ville Talvalab2675542012-12-12 13:29:45 -080078 *
Igor Murashkinb519cc52013-07-02 11:23:44 -070079 * @throws IllegalArgumentException if the key was not valid
80 *
Benjamin Hendricks24eb8a32013-08-15 12:46:22 -070081 * @param key The metadata field to read.
82 * @return The value of that key, or {@code null} if the field is not set.
Igor Murashkind6d65152014-05-19 16:31:02 -070083 *
84 * @hide
Eino-Ville Talvalab2675542012-12-12 13:29:45 -080085 */
Igor Murashkind6d65152014-05-19 16:31:02 -070086 protected abstract <T> T getProtected(TKey key);
87
88 /**
89 * @hide
90 */
91 protected abstract Class<TKey> getKeyClass();
Eino-Ville Talvalab2675542012-12-12 13:29:45 -080092
Igor Murashkin7a36a0f2013-09-10 18:13:09 -070093 /**
94 * Returns a list of the keys contained in this map.
95 *
96 * <p>The list returned is not modifiable, so any attempts to modify it will throw
97 * a {@code UnsupportedOperationException}.</p>
98 *
Igor Murashkind6d65152014-05-19 16:31:02 -070099 * <p>All values retrieved by a key from this list with {@code #get} are guaranteed to be
Igor Murashkin7a36a0f2013-09-10 18:13:09 -0700100 * non-{@code null}. Each key is only listed once in the list. The order of the keys
101 * is undefined.</p>
102 *
103 * @return List of the keys contained in this map.
104 */
Igor Murashkind6d65152014-05-19 16:31:02 -0700105 @SuppressWarnings("unchecked")
106 public List<TKey> getKeys() {
107 Class<CameraMetadata<TKey>> thisClass = (Class<CameraMetadata<TKey>>) getClass();
Igor Murashkincc542a42014-06-25 11:52:23 -0700108 return Collections.unmodifiableList(
109 getKeysStatic(thisClass, getKeyClass(), this, /*filterTags*/null));
Igor Murashkin7a36a0f2013-09-10 18:13:09 -0700110 }
111
112 /**
113 * Return a list of all the Key<?> that are declared as a field inside of the class
114 * {@code type}.
115 *
116 * <p>
117 * Optionally, if {@code instance} is not null, then filter out any keys with null values.
118 * </p>
Igor Murashkincc542a42014-06-25 11:52:23 -0700119 *
120 * <p>
121 * Optionally, if {@code filterTags} is not {@code null}, then filter out any keys
122 * whose native {@code tag} is not in {@code filterTags}. The {@code filterTags} array will be
123 * sorted as a side effect.
124 * </p>
Igor Murashkin7a36a0f2013-09-10 18:13:09 -0700125 */
Igor Murashkind6d65152014-05-19 16:31:02 -0700126 /*package*/ @SuppressWarnings("unchecked")
127 static <TKey> ArrayList<TKey> getKeysStatic(
128 Class<?> type, Class<TKey> keyClass,
Igor Murashkincc542a42014-06-25 11:52:23 -0700129 CameraMetadata<TKey> instance,
130 int[] filterTags) {
Igor Murashkind6d65152014-05-19 16:31:02 -0700131
132 if (VERBOSE) Log.v(TAG, "getKeysStatic for " + type);
133
Igor Murashkin696bbee2014-08-07 18:02:51 -0700134 // TotalCaptureResult does not have any of the keys on it, use CaptureResult instead
135 if (type.equals(TotalCaptureResult.class)) {
136 type = CaptureResult.class;
137 }
138
Igor Murashkincc542a42014-06-25 11:52:23 -0700139 if (filterTags != null) {
140 Arrays.sort(filterTags);
141 }
142
Igor Murashkind6d65152014-05-19 16:31:02 -0700143 ArrayList<TKey> keyList = new ArrayList<TKey>();
Igor Murashkin7a36a0f2013-09-10 18:13:09 -0700144
145 Field[] fields = type.getDeclaredFields();
146 for (Field field : fields) {
Igor Murashkin03fdb142013-09-30 12:14:58 -0700147 // Filter for Keys that are public
Igor Murashkind6d65152014-05-19 16:31:02 -0700148 if (field.getType().isAssignableFrom(keyClass) &&
Igor Murashkin03fdb142013-09-30 12:14:58 -0700149 (field.getModifiers() & Modifier.PUBLIC) != 0) {
Igor Murashkind6d65152014-05-19 16:31:02 -0700150
151 TKey key;
Igor Murashkin7a36a0f2013-09-10 18:13:09 -0700152 try {
Igor Murashkind6d65152014-05-19 16:31:02 -0700153 key = (TKey) field.get(instance);
Igor Murashkin7a36a0f2013-09-10 18:13:09 -0700154 } catch (IllegalAccessException e) {
155 throw new AssertionError("Can't get IllegalAccessException", e);
156 } catch (IllegalArgumentException e) {
157 throw new AssertionError("Can't get IllegalArgumentException", e);
158 }
Igor Murashkind6d65152014-05-19 16:31:02 -0700159
160 if (instance == null || instance.getProtected(key) != null) {
Igor Murashkin6c76f582014-07-15 17:19:49 -0700161 if (shouldKeyBeAdded(key, field, filterTags)) {
Igor Murashkincc542a42014-06-25 11:52:23 -0700162 keyList.add(key);
163
164 if (VERBOSE) {
165 Log.v(TAG, "getKeysStatic - key was added - " + key);
166 }
167 } else if (VERBOSE) {
168 Log.v(TAG, "getKeysStatic - key was filtered - " + key);
169 }
Igor Murashkin7a36a0f2013-09-10 18:13:09 -0700170 }
171 }
172 }
173
174 return keyList;
175 }
176
Igor Murashkincc542a42014-06-25 11:52:23 -0700177 @SuppressWarnings("rawtypes")
Igor Murashkin6c76f582014-07-15 17:19:49 -0700178 private static <TKey> boolean shouldKeyBeAdded(TKey key, Field field, int[] filterTags) {
Igor Murashkincc542a42014-06-25 11:52:23 -0700179 if (key == null) {
180 throw new NullPointerException("key must not be null");
181 }
182
183 CameraMetadataNative.Key nativeKey;
184
185 /*
186 * Get the native key from the public api key
187 */
188 if (key instanceof CameraCharacteristics.Key) {
189 nativeKey = ((CameraCharacteristics.Key)key).getNativeKey();
190 } else if (key instanceof CaptureResult.Key) {
191 nativeKey = ((CaptureResult.Key)key).getNativeKey();
192 } else if (key instanceof CaptureRequest.Key) {
193 nativeKey = ((CaptureRequest.Key)key).getNativeKey();
194 } else {
195 // Reject fields that aren't a key
196 throw new IllegalArgumentException("key type must be that of a metadata key");
197 }
198
Igor Murashkin6c76f582014-07-15 17:19:49 -0700199 if (field.getAnnotation(PublicKey.class) == null) {
200 // Never expose @hide keys up to the API user
201 return false;
202 }
203
Igor Murashkincc542a42014-06-25 11:52:23 -0700204 // No filtering necessary
205 if (filterTags == null) {
206 return true;
207 }
208
Igor Murashkin6c76f582014-07-15 17:19:49 -0700209 if (field.getAnnotation(SyntheticKey.class) != null) {
210 // This key is synthetic, so calling #getTag will throw IAE
211
212 // TODO: don't just assume all public+synthetic keys are always available
213 return true;
214 }
215
216 /*
217 * Regular key: look up it's native tag and see if it's in filterTags
218 */
219
Igor Murashkincc542a42014-06-25 11:52:23 -0700220 int keyTag = nativeKey.getTag();
221
222 // non-negative result is returned iff the value is in the array
223 return Arrays.binarySearch(filterTags, keyTag) >= 0;
224 }
225
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700226 /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~
227 * The enum values below this point are generated from metadata
228 * definitions in /system/media/camera/docs. Do not modify by hand or
229 * modify the comment blocks at the start or end.
230 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/
231
232 //
Zhijun Heff413932014-02-07 15:44:30 -0800233 // Enumeration values for CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION
234 //
235
236 /**
237 * <p>The lens focus distance is not accurate, and the units used for
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700238 * {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} do not correspond to any physical units.</p>
239 * <p>Setting the lens to the same focus distance on separate occasions may
Zhijun Heff413932014-02-07 15:44:30 -0800240 * result in a different real focus distance, depending on factors such
241 * as the orientation of the device, the age of the focusing mechanism,
242 * and the device temperature. The focus distance value will still be
243 * in the range of <code>[0, {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance}]</code>, where 0
244 * represents the farthest focus.</p>
245 *
246 * @see CaptureRequest#LENS_FOCUS_DISTANCE
247 * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE
248 * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION
249 */
250 public static final int LENS_INFO_FOCUS_DISTANCE_CALIBRATION_UNCALIBRATED = 0;
251
252 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700253 * <p>The lens focus distance is measured in diopters.</p>
254 * <p>However, setting the lens to the same focus distance
255 * on separate occasions may result in a different real
256 * focus distance, depending on factors such as the
257 * orientation of the device, the age of the focusing
258 * mechanism, and the device temperature.</p>
Zhijun Heff413932014-02-07 15:44:30 -0800259 * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION
260 */
261 public static final int LENS_INFO_FOCUS_DISTANCE_CALIBRATION_APPROXIMATE = 1;
262
263 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700264 * <p>The lens focus distance is measured in diopters, and
265 * is calibrated.</p>
266 * <p>The lens mechanism is calibrated so that setting the
267 * same focus distance is repeatable on multiple
268 * occasions with good accuracy, and the focus distance
269 * corresponds to the real physical distance to the plane
270 * of best focus.</p>
Zhijun Heff413932014-02-07 15:44:30 -0800271 * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION
272 */
273 public static final int LENS_INFO_FOCUS_DISTANCE_CALIBRATION_CALIBRATED = 2;
274
275 //
Igor Murashkin68f40062013-09-10 12:15:54 -0700276 // Enumeration values for CameraCharacteristics#LENS_FACING
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700277 //
278
279 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700280 * <p>The camera device faces the same direction as the device's screen.</p>
Igor Murashkin68f40062013-09-10 12:15:54 -0700281 * @see CameraCharacteristics#LENS_FACING
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700282 */
283 public static final int LENS_FACING_FRONT = 0;
284
285 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700286 * <p>The camera device faces the opposite direction as the device's screen.</p>
Igor Murashkin68f40062013-09-10 12:15:54 -0700287 * @see CameraCharacteristics#LENS_FACING
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700288 */
289 public static final int LENS_FACING_BACK = 1;
290
Zhijun He503e8152015-01-12 15:16:56 -0800291 /**
292 * <p>The camera device is an external camera, and has no fixed facing relative to the
293 * device's screen.</p>
294 * @see CameraCharacteristics#LENS_FACING
295 */
296 public static final int LENS_FACING_EXTERNAL = 2;
297
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700298 //
Igor Murashkine46c0da2014-02-07 18:34:37 -0800299 // Enumeration values for CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
300 //
301
302 /**
303 * <p>The minimal set of capabilities that every camera
304 * device (regardless of {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel})
Eino-Ville Talvala08bc3b02014-07-09 10:07:36 -0700305 * supports.</p>
306 * <p>This capability is listed by all devices, and
307 * indicates that the camera device has a feature set
308 * that's comparable to the baseline requirements for the
309 * older android.hardware.Camera API.</p>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800310 *
311 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
312 * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
313 */
314 public static final int REQUEST_AVAILABLE_CAPABILITIES_BACKWARD_COMPATIBLE = 0;
315
316 /**
Igor Murashkine46c0da2014-02-07 18:34:37 -0800317 * <p>The camera device can be manually controlled (3A algorithms such
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700318 * as auto-exposure, and auto-focus can be bypassed).
Zhijun He50f72432014-05-28 13:52:04 -0700319 * The camera device supports basic manual control of the sensor image
320 * acquisition related stages. This means the following controls are
321 * guaranteed to be supported:</p>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800322 * <ul>
Zhijun He50f72432014-05-28 13:52:04 -0700323 * <li>Manual frame duration control<ul>
324 * <li>{@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}</li>
325 * <li>{@link CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION android.sensor.info.maxFrameDuration}</li>
Zhijun He50f72432014-05-28 13:52:04 -0700326 * </ul>
327 * </li>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800328 * <li>Manual exposure control<ul>
329 * <li>{@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}</li>
330 * <li>{@link CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE android.sensor.info.exposureTimeRange}</li>
331 * </ul>
332 * </li>
333 * <li>Manual sensitivity control<ul>
334 * <li>{@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}</li>
335 * <li>{@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}</li>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800336 * </ul>
337 * </li>
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700338 * <li>Manual lens control (if the lens is adjustable)<ul>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800339 * <li>android.lens.*</li>
340 * </ul>
341 * </li>
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700342 * <li>Manual flash control (if a flash unit is present)<ul>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800343 * <li>android.flash.*</li>
344 * </ul>
345 * </li>
346 * <li>Manual black level locking<ul>
347 * <li>{@link CaptureRequest#BLACK_LEVEL_LOCK android.blackLevel.lock}</li>
348 * </ul>
349 * </li>
Yin-Chia Yeh7e3e4312015-04-02 14:34:30 -0700350 * <li>Auto exposure lock<ul>
351 * <li>{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock}</li>
352 * </ul>
353 * </li>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800354 * </ul>
355 * <p>If any of the above 3A algorithms are enabled, then the camera
356 * device will accurately report the values applied by 3A in the
357 * result.</p>
Zhijun He50f72432014-05-28 13:52:04 -0700358 * <p>A given camera device may also support additional manual sensor controls,
359 * but this capability only covers the above list of controls.</p>
Ruben Brunk3e4fed22014-06-18 17:08:42 -0700360 * <p>If this is supported, {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} will
361 * additionally return a min frame duration that is greater than
362 * zero for each supported size-format combination.</p>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800363 *
364 * @see CaptureRequest#BLACK_LEVEL_LOCK
Yin-Chia Yeh7e3e4312015-04-02 14:34:30 -0700365 * @see CaptureRequest#CONTROL_AE_LOCK
Zhijun He50f72432014-05-28 13:52:04 -0700366 * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP
Igor Murashkine46c0da2014-02-07 18:34:37 -0800367 * @see CaptureRequest#SENSOR_EXPOSURE_TIME
Zhijun He50f72432014-05-28 13:52:04 -0700368 * @see CaptureRequest#SENSOR_FRAME_DURATION
Igor Murashkine46c0da2014-02-07 18:34:37 -0800369 * @see CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE
Zhijun He50f72432014-05-28 13:52:04 -0700370 * @see CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION
Igor Murashkine46c0da2014-02-07 18:34:37 -0800371 * @see CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE
372 * @see CaptureRequest#SENSOR_SENSITIVITY
373 * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
374 */
Eino-Ville Talvala08bc3b02014-07-09 10:07:36 -0700375 public static final int REQUEST_AVAILABLE_CAPABILITIES_MANUAL_SENSOR = 1;
Igor Murashkine46c0da2014-02-07 18:34:37 -0800376
377 /**
Zhijun He50f72432014-05-28 13:52:04 -0700378 * <p>The camera device post-processing stages can be manually controlled.
379 * The camera device supports basic manual control of the image post-processing
380 * stages. This means the following controls are guaranteed to be supported:</p>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800381 * <ul>
Yin-Chia Yeh956c52b2015-02-06 11:23:25 -0800382 * <li>
383 * <p>Manual tonemap control</p>
384 * <ul>
Yin-Chia Yeh8490ace2014-05-27 10:04:54 -0700385 * <li>{@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}</li>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800386 * <li>{@link CaptureRequest#TONEMAP_MODE android.tonemap.mode}</li>
387 * <li>{@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</li>
Yin-Chia Yehdc0ba092015-02-20 15:52:06 -0800388 * <li>android.tonemap.gamma</li>
389 * <li>android.tonemap.presetCurve</li>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800390 * </ul>
391 * </li>
Yin-Chia Yeh956c52b2015-02-06 11:23:25 -0800392 * <li>
393 * <p>Manual white balance control</p>
394 * <ul>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800395 * <li>{@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}</li>
396 * <li>{@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains}</li>
397 * </ul>
398 * </li>
Zhijun He28288ca2014-06-25 15:49:13 -0700399 * <li>Manual lens shading map control<ul>
400 * <li>{@link CaptureRequest#SHADING_MODE android.shading.mode}</li>
401 * <li>{@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode}</li>
Ruben Brunk57493682014-05-27 18:58:08 -0700402 * <li>android.statistics.lensShadingMap</li>
403 * <li>android.lens.info.shadingMapSize</li>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800404 * </ul>
405 * </li>
Zhijun Hea05e59d2014-07-08 18:27:47 -0700406 * <li>Manual aberration correction control (if aberration correction is supported)<ul>
Zhijun He9e4e4392014-08-18 11:12:32 -0700407 * <li>{@link CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE android.colorCorrection.aberrationMode}</li>
408 * <li>{@link CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES android.colorCorrection.availableAberrationModes}</li>
Zhijun Hea05e59d2014-07-08 18:27:47 -0700409 * </ul>
410 * </li>
Yin-Chia Yeh7e3e4312015-04-02 14:34:30 -0700411 * <li>Auto white balance lock<ul>
412 * <li>{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock}</li>
413 * </ul>
414 * </li>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800415 * </ul>
416 * <p>If auto white balance is enabled, then the camera device
417 * will accurately report the values applied by AWB in the result.</p>
Zhijun He50f72432014-05-28 13:52:04 -0700418 * <p>A given camera device may also support additional post-processing
419 * controls, but this capability only covers the above list of controls.</p>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800420 *
Zhijun He9e4e4392014-08-18 11:12:32 -0700421 * @see CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE
422 * @see CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES
Igor Murashkine46c0da2014-02-07 18:34:37 -0800423 * @see CaptureRequest#COLOR_CORRECTION_GAINS
424 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
Yin-Chia Yeh7e3e4312015-04-02 14:34:30 -0700425 * @see CaptureRequest#CONTROL_AWB_LOCK
Zhijun He28288ca2014-06-25 15:49:13 -0700426 * @see CaptureRequest#SHADING_MODE
427 * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE
Yin-Chia Yeh8490ace2014-05-27 10:04:54 -0700428 * @see CaptureRequest#TONEMAP_CURVE
Igor Murashkine46c0da2014-02-07 18:34:37 -0800429 * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS
430 * @see CaptureRequest#TONEMAP_MODE
431 * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
432 */
Eino-Ville Talvala08bc3b02014-07-09 10:07:36 -0700433 public static final int REQUEST_AVAILABLE_CAPABILITIES_MANUAL_POST_PROCESSING = 2;
434
435 /**
Eino-Ville Talvala611fece2014-07-10 17:29:38 -0700436 * <p>The camera device supports outputting RAW buffers and
437 * metadata for interpreting them.</p>
438 * <p>Devices supporting the RAW capability allow both for
439 * saving DNG files, and for direct application processing of
440 * raw sensor images.</p>
Eino-Ville Talvala08bc3b02014-07-09 10:07:36 -0700441 * <ul>
442 * <li>RAW_SENSOR is supported as an output format.</li>
443 * <li>The maximum available resolution for RAW_SENSOR streams
Eino-Ville Talvalafd3e2892014-10-06 10:23:55 -0700444 * will match either the value in
445 * {@link CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE android.sensor.info.pixelArraySize} or
446 * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.</li>
Eino-Ville Talvala08bc3b02014-07-09 10:07:36 -0700447 * <li>All DNG-related optional metadata entries are provided
Eino-Ville Talvalafd3e2892014-10-06 10:23:55 -0700448 * by the camera device.</li>
Eino-Ville Talvala08bc3b02014-07-09 10:07:36 -0700449 * </ul>
450 *
451 * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
452 * @see CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE
453 * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
454 */
Eino-Ville Talvala611fece2014-07-10 17:29:38 -0700455 public static final int REQUEST_AVAILABLE_CAPABILITIES_RAW = 3;
Igor Murashkine46c0da2014-02-07 18:34:37 -0800456
457 /**
Zhijun He0e99c222015-01-29 15:26:05 -0800458 * <p>The camera device supports the Zero Shutter Lag reprocessing use case.</p>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800459 * <ul>
Zhijun He0e99c222015-01-29 15:26:05 -0800460 * <li>One input stream is supported, that is, <code>{@link CameraCharacteristics#REQUEST_MAX_NUM_INPUT_STREAMS android.request.maxNumInputStreams} == 1</code>.</li>
461 * <li>OPAQUE is supported as an output/input format, that is,
462 * StreamConfigurationMap#getOutputSizes(klass) and
463 * StreamConfigurationMap#getInputSizes(klass) return non empty Size[] and have common
464 * sizes, where klass is android.media.OpaqueImageRingBufferQueue.class. See
465 * android.scaler.availableInputOutputFormatsMap for detailed information about
466 * OPAQUE format.</li>
467 * <li>android.scaler.availableInputOutputFormatsMap has the required map entries.</li>
468 * <li>Using OPAQUE does not cause a frame rate drop
Eino-Ville Talvalafd3e2892014-10-06 10:23:55 -0700469 * relative to the sensor's maximum capture rate (at that
Zhijun He0e99c222015-01-29 15:26:05 -0800470 * resolution), see android.scaler.availableInputOutputFormatsMap for more details.</li>
471 * <li>OPAQUE will be reprocessable into both YUV_420_888
Eino-Ville Talvalafd3e2892014-10-06 10:23:55 -0700472 * and JPEG formats.</li>
Zhijun He0e99c222015-01-29 15:26:05 -0800473 * <li>The maximum available resolution for OPAQUE streams
Eino-Ville Talvalafd3e2892014-10-06 10:23:55 -0700474 * (both input/output) will match the maximum available
475 * resolution of JPEG streams.</li>
Zhijun He0e99c222015-01-29 15:26:05 -0800476 * <li>Only below controls are effective for reprocessing requests and
477 * will be present in capture results, other controls in reprocess
478 * requests will be ignored by the camera device.<ul>
479 * <li>android.jpeg.*</li>
480 * <li>{@link CaptureRequest#NOISE_REDUCTION_MODE android.noiseReduction.mode}</li>
481 * <li>{@link CaptureRequest#EDGE_MODE android.edge.mode}</li>
Igor Murashkine46c0da2014-02-07 18:34:37 -0800482 * </ul>
Zhijun He0e99c222015-01-29 15:26:05 -0800483 * </li>
484 * </ul>
485 *
486 * @see CaptureRequest#EDGE_MODE
487 * @see CaptureRequest#NOISE_REDUCTION_MODE
488 * @see CameraCharacteristics#REQUEST_MAX_NUM_INPUT_STREAMS
Igor Murashkine46c0da2014-02-07 18:34:37 -0800489 * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
490 */
Zhijun He0e99c222015-01-29 15:26:05 -0800491 public static final int REQUEST_AVAILABLE_CAPABILITIES_OPAQUE_REPROCESSING = 4;
Igor Murashkine46c0da2014-02-07 18:34:37 -0800492
Ruben Brunk0c22e692014-11-11 12:00:34 -0800493 /**
494 * <p>The camera device supports accurately reporting the sensor settings for many of
495 * the sensor controls while the built-in 3A algorithm is running. This allows
496 * reporting of sensor settings even when these settings cannot be manually changed.</p>
497 * <p>The values reported for the following controls are guaranteed to be available
498 * in the CaptureResult, including when 3A is enabled:</p>
499 * <ul>
500 * <li>Exposure control<ul>
501 * <li>{@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}</li>
502 * </ul>
503 * </li>
504 * <li>Sensitivity control<ul>
505 * <li>{@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}</li>
506 * </ul>
507 * </li>
508 * <li>Lens controls (if the lens is adjustable)<ul>
509 * <li>{@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance}</li>
510 * <li>{@link CaptureRequest#LENS_APERTURE android.lens.aperture}</li>
511 * </ul>
512 * </li>
513 * </ul>
514 * <p>This capability is a subset of the MANUAL_SENSOR control capability, and will
515 * always be included if the MANUAL_SENSOR capability is available.</p>
516 *
517 * @see CaptureRequest#LENS_APERTURE
518 * @see CaptureRequest#LENS_FOCUS_DISTANCE
519 * @see CaptureRequest#SENSOR_EXPOSURE_TIME
520 * @see CaptureRequest#SENSOR_SENSITIVITY
521 * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
522 */
523 public static final int REQUEST_AVAILABLE_CAPABILITIES_READ_SENSOR_SETTINGS = 5;
524
Eino-Ville Talvala126a7462014-11-04 16:31:01 -0800525 /**
526 * <p>The camera device supports capturing maximum-resolution
527 * images at &gt;= 20 frames per second, in at least the
528 * uncompressed YUV format, when post-processing settings
529 * are set to FAST.</p>
530 * <p>More specifically, this means that a size matching the
531 * camera device's active array size is listed as a
532 * supported size for the YUV_420_888 format in
Eino-Ville Talvala8d709f32014-11-17 11:28:38 -0800533 * {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap}, the minimum frame
534 * duration for that format and size is &lt;= 1/20 s, and
535 * the {@link CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES android.control.aeAvailableTargetFpsRanges} entry
Yin-Chia Yeh7b2cae62014-11-25 11:54:18 -0800536 * lists at least one FPS range where the minimum FPS is</p>
537 * <blockquote>
538 * <p>= 1 / minimumFrameDuration for the maximum-size
Eino-Ville Talvala8d709f32014-11-17 11:28:38 -0800539 * YUV_420_888 format.</p>
Yin-Chia Yeh7b2cae62014-11-25 11:54:18 -0800540 * </blockquote>
Eino-Ville Talvala126a7462014-11-04 16:31:01 -0800541 * <p>In addition, the {@link CameraCharacteristics#SYNC_MAX_LATENCY android.sync.maxLatency} field is
Yin-Chia Yeh7e3e4312015-04-02 14:34:30 -0700542 * guaranted to have a value between 0 and 4, inclusive.
543 * {@link CameraCharacteristics#CONTROL_AE_LOCK_AVAILABLE android.control.aeLockAvailable} and
544 * {@link CameraCharacteristics#CONTROL_AWB_LOCK_AVAILABLE android.control.awbLockAvailable} are also guaranteed
545 * to be <code>true</code> so burst capture with these two locks ON
546 * yields consistent image output.</p>
Eino-Ville Talvala126a7462014-11-04 16:31:01 -0800547 *
Eino-Ville Talvala8d709f32014-11-17 11:28:38 -0800548 * @see CameraCharacteristics#CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES
Yin-Chia Yeh7e3e4312015-04-02 14:34:30 -0700549 * @see CameraCharacteristics#CONTROL_AE_LOCK_AVAILABLE
550 * @see CameraCharacteristics#CONTROL_AWB_LOCK_AVAILABLE
Eino-Ville Talvala126a7462014-11-04 16:31:01 -0800551 * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP
552 * @see CameraCharacteristics#SYNC_MAX_LATENCY
553 * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
554 */
555 public static final int REQUEST_AVAILABLE_CAPABILITIES_BURST_CAPTURE = 6;
556
Zhijun He0e99c222015-01-29 15:26:05 -0800557 /**
558 * <p>The camera device supports the YUV420_888 reprocessing use case, similar as
559 * OPAQUE_REPROCESSING, This capability requires the camera device to support the
560 * following:</p>
561 * <ul>
562 * <li>One input stream is supported, that is, <code>{@link CameraCharacteristics#REQUEST_MAX_NUM_INPUT_STREAMS android.request.maxNumInputStreams} == 1</code>.</li>
563 * <li>YUV420_888 is supported as a common format for both input and output, that is,
564 * StreamConfigurationMap#getOutputSizes(YUV420_888) and
565 * StreamConfigurationMap#getInputSizes(YUV420_888) return non empty Size[] and have
566 * common sizes.</li>
567 * <li>android.scaler.availableInputOutputFormatsMap has the required map entries.</li>
568 * <li>Using YUV420_888 does not cause a frame rate drop
569 * relative to the sensor's maximum capture rate (at that
570 * resolution), see android.scaler.availableInputOutputFormatsMap for more details.</li>
571 * <li>YUV420_888 will be reprocessable into both YUV_420_888
572 * and JPEG formats.</li>
573 * <li>The maximum available resolution for YUV420_888 streams
574 * (both input/output) will match the maximum available
575 * resolution of JPEG streams.</li>
576 * <li>Only the below controls are effective for reprocessing requests and will be
577 * present in capture results. The reprocess requests are from the original capture
578 * results that are assocaited with the intermidate YUV420_888 output buffers.
579 * All other controls in the reprocess requests will be ignored by the camera device.<ul>
580 * <li>android.jpeg.*</li>
581 * <li>{@link CaptureRequest#NOISE_REDUCTION_MODE android.noiseReduction.mode}</li>
582 * <li>{@link CaptureRequest#EDGE_MODE android.edge.mode}</li>
583 * <li>{@link CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR android.reprocess.effectiveExposureFactor}</li>
584 * </ul>
585 * </li>
586 * </ul>
587 *
588 * @see CaptureRequest#EDGE_MODE
589 * @see CaptureRequest#NOISE_REDUCTION_MODE
590 * @see CaptureRequest#REPROCESS_EFFECTIVE_EXPOSURE_FACTOR
591 * @see CameraCharacteristics#REQUEST_MAX_NUM_INPUT_STREAMS
592 * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
593 */
594 public static final int REQUEST_AVAILABLE_CAPABILITIES_YUV_REPROCESSING = 7;
595
Igor Murashkine46c0da2014-02-07 18:34:37 -0800596 //
Zhijun He14986152014-05-22 21:17:37 -0700597 // Enumeration values for CameraCharacteristics#SCALER_CROPPING_TYPE
598 //
599
600 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700601 * <p>The camera device only supports centered crop regions.</p>
Zhijun He14986152014-05-22 21:17:37 -0700602 * @see CameraCharacteristics#SCALER_CROPPING_TYPE
603 */
604 public static final int SCALER_CROPPING_TYPE_CENTER_ONLY = 0;
605
606 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700607 * <p>The camera device supports arbitrarily chosen crop regions.</p>
Zhijun He14986152014-05-22 21:17:37 -0700608 * @see CameraCharacteristics#SCALER_CROPPING_TYPE
609 */
610 public static final int SCALER_CROPPING_TYPE_FREEFORM = 1;
611
612 //
Zhijun Hed1784962014-04-08 17:41:46 -0700613 // Enumeration values for CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT
614 //
615
616 /**
617 * @see CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT
618 */
619 public static final int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGGB = 0;
620
621 /**
622 * @see CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT
623 */
624 public static final int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GRBG = 1;
625
626 /**
627 * @see CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT
628 */
629 public static final int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GBRG = 2;
630
631 /**
632 * @see CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT
633 */
634 public static final int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_BGGR = 3;
635
636 /**
637 * <p>Sensor is not Bayer; output has 3 16-bit
638 * values for each pixel, instead of just 1 16-bit value
639 * per pixel.</p>
640 * @see CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT
641 */
642 public static final int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGB = 4;
643
644 //
Eino-Ville Talvalaabd9d3c2014-07-28 13:01:52 -0700645 // Enumeration values for CameraCharacteristics#SENSOR_INFO_TIMESTAMP_SOURCE
Zhijun He45fa43a12014-06-13 18:29:37 -0700646 //
647
648 /**
649 * <p>Timestamps from {@link CaptureResult#SENSOR_TIMESTAMP android.sensor.timestamp} are in nanoseconds and monotonic,
650 * but can not be compared to timestamps from other subsystems
651 * (e.g. accelerometer, gyro etc.), or other instances of the same or different
652 * camera devices in the same system. Timestamps between streams and results for
653 * a single camera instance are comparable, and the timestamps for all buffers
654 * and the result metadata generated by a single capture are identical.</p>
655 *
656 * @see CaptureResult#SENSOR_TIMESTAMP
Eino-Ville Talvalaabd9d3c2014-07-28 13:01:52 -0700657 * @see CameraCharacteristics#SENSOR_INFO_TIMESTAMP_SOURCE
Zhijun He45fa43a12014-06-13 18:29:37 -0700658 */
Eino-Ville Talvalaabd9d3c2014-07-28 13:01:52 -0700659 public static final int SENSOR_INFO_TIMESTAMP_SOURCE_UNKNOWN = 0;
Zhijun He45fa43a12014-06-13 18:29:37 -0700660
661 /**
662 * <p>Timestamps from {@link CaptureResult#SENSOR_TIMESTAMP android.sensor.timestamp} are in the same timebase as
663 * android.os.SystemClock#elapsedRealtimeNanos(),
664 * and they can be compared to other timestamps using that base.</p>
665 *
666 * @see CaptureResult#SENSOR_TIMESTAMP
Eino-Ville Talvalaabd9d3c2014-07-28 13:01:52 -0700667 * @see CameraCharacteristics#SENSOR_INFO_TIMESTAMP_SOURCE
Zhijun He45fa43a12014-06-13 18:29:37 -0700668 */
Eino-Ville Talvalaabd9d3c2014-07-28 13:01:52 -0700669 public static final int SENSOR_INFO_TIMESTAMP_SOURCE_REALTIME = 1;
Zhijun He45fa43a12014-06-13 18:29:37 -0700670
671 //
Ruben Brunk7c062362014-04-15 23:53:53 -0700672 // Enumeration values for CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
673 //
674
675 /**
676 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
677 */
678 public static final int SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT = 1;
679
680 /**
681 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
682 */
683 public static final int SENSOR_REFERENCE_ILLUMINANT1_FLUORESCENT = 2;
684
685 /**
686 * <p>Incandescent light</p>
687 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
688 */
689 public static final int SENSOR_REFERENCE_ILLUMINANT1_TUNGSTEN = 3;
690
691 /**
692 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
693 */
694 public static final int SENSOR_REFERENCE_ILLUMINANT1_FLASH = 4;
695
696 /**
697 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
698 */
699 public static final int SENSOR_REFERENCE_ILLUMINANT1_FINE_WEATHER = 9;
700
701 /**
702 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
703 */
704 public static final int SENSOR_REFERENCE_ILLUMINANT1_CLOUDY_WEATHER = 10;
705
706 /**
707 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
708 */
709 public static final int SENSOR_REFERENCE_ILLUMINANT1_SHADE = 11;
710
711 /**
712 * <p>D 5700 - 7100K</p>
713 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
714 */
715 public static final int SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT_FLUORESCENT = 12;
716
717 /**
718 * <p>N 4600 - 5400K</p>
719 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
720 */
721 public static final int SENSOR_REFERENCE_ILLUMINANT1_DAY_WHITE_FLUORESCENT = 13;
722
723 /**
724 * <p>W 3900 - 4500K</p>
725 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
726 */
727 public static final int SENSOR_REFERENCE_ILLUMINANT1_COOL_WHITE_FLUORESCENT = 14;
728
729 /**
730 * <p>WW 3200 - 3700K</p>
731 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
732 */
733 public static final int SENSOR_REFERENCE_ILLUMINANT1_WHITE_FLUORESCENT = 15;
734
735 /**
736 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
737 */
738 public static final int SENSOR_REFERENCE_ILLUMINANT1_STANDARD_A = 17;
739
740 /**
741 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
742 */
743 public static final int SENSOR_REFERENCE_ILLUMINANT1_STANDARD_B = 18;
744
745 /**
746 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
747 */
748 public static final int SENSOR_REFERENCE_ILLUMINANT1_STANDARD_C = 19;
749
750 /**
751 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
752 */
753 public static final int SENSOR_REFERENCE_ILLUMINANT1_D55 = 20;
754
755 /**
756 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
757 */
758 public static final int SENSOR_REFERENCE_ILLUMINANT1_D65 = 21;
759
760 /**
761 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
762 */
763 public static final int SENSOR_REFERENCE_ILLUMINANT1_D75 = 22;
764
765 /**
766 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
767 */
768 public static final int SENSOR_REFERENCE_ILLUMINANT1_D50 = 23;
769
770 /**
771 * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
772 */
773 public static final int SENSOR_REFERENCE_ILLUMINANT1_ISO_STUDIO_TUNGSTEN = 24;
774
775 //
Igor Murashkin68f40062013-09-10 12:15:54 -0700776 // Enumeration values for CameraCharacteristics#LED_AVAILABLE_LEDS
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700777 //
778
779 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700780 * <p>android.led.transmit control is used.</p>
Igor Murashkin68f40062013-09-10 12:15:54 -0700781 * @see CameraCharacteristics#LED_AVAILABLE_LEDS
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700782 * @hide
783 */
784 public static final int LED_AVAILABLE_LEDS_TRANSMIT = 0;
785
786 //
Igor Murashkin68f40062013-09-10 12:15:54 -0700787 // Enumeration values for CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700788 //
789
790 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700791 * <p>This camera device has only limited capabilities.</p>
Igor Murashkin68f40062013-09-10 12:15:54 -0700792 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700793 */
794 public static final int INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED = 0;
795
796 /**
Ruben Brunk4a61a862014-07-01 16:00:26 -0700797 * <p>This camera device is capable of supporting advanced imaging applications.</p>
Igor Murashkin68f40062013-09-10 12:15:54 -0700798 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700799 */
800 public static final int INFO_SUPPORTED_HARDWARE_LEVEL_FULL = 1;
801
Ruben Brunk4a61a862014-07-01 16:00:26 -0700802 /**
803 * <p>This camera device is running in backward compatibility mode.</p>
804 * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
805 */
806 public static final int INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY = 2;
807
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700808 //
Igor Murashkin3865a842014-01-17 18:18:39 -0800809 // Enumeration values for CameraCharacteristics#SYNC_MAX_LATENCY
810 //
811
812 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700813 * <p>Every frame has the requests immediately applied.</p>
814 * <p>Furthermore for all results,
Igor Murashkinbdf366c2014-07-25 16:54:20 -0700815 * <code>android.sync.frameNumber == CaptureResult#getFrameNumber()</code></p>
Igor Murashkin3865a842014-01-17 18:18:39 -0800816 * <p>Changing controls over multiple requests one after another will
817 * produce results that have those controls applied atomically
818 * each frame.</p>
819 * <p>All FULL capability devices will have this as their maxLatency.</p>
820 * @see CameraCharacteristics#SYNC_MAX_LATENCY
821 */
822 public static final int SYNC_MAX_LATENCY_PER_FRAME_CONTROL = 0;
823
824 /**
825 * <p>Each new frame has some subset (potentially the entire set)
826 * of the past requests applied to the camera settings.</p>
827 * <p>By submitting a series of identical requests, the camera device
828 * will eventually have the camera settings applied, but it is
829 * unknown when that exact point will be.</p>
Igor Murashkinbdf366c2014-07-25 16:54:20 -0700830 * <p>All LEGACY capability devices will have this as their maxLatency.</p>
Igor Murashkin3865a842014-01-17 18:18:39 -0800831 * @see CameraCharacteristics#SYNC_MAX_LATENCY
832 */
833 public static final int SYNC_MAX_LATENCY_UNKNOWN = -1;
834
835 //
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700836 // Enumeration values for CaptureRequest#COLOR_CORRECTION_MODE
837 //
838
839 /**
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -0800840 * <p>Use the {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} matrix
Igor Murashkin7d2a5c52014-01-17 15:07:52 -0800841 * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} to do color conversion.</p>
842 * <p>All advanced white balance adjustments (not specified
843 * by our white balance pipeline) must be disabled.</p>
844 * <p>If AWB is enabled with <code>{@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} != OFF</code>, then
845 * TRANSFORM_MATRIX is ignored. The camera device will override
846 * this value to either FAST or HIGH_QUALITY.</p>
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -0800847 *
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -0800848 * @see CaptureRequest#COLOR_CORRECTION_GAINS
Eino-Ville Talvala265b34c2014-01-16 16:18:52 -0800849 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
Igor Murashkin7d2a5c52014-01-17 15:07:52 -0800850 * @see CaptureRequest#CONTROL_AWB_MODE
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700851 * @see CaptureRequest#COLOR_CORRECTION_MODE
852 */
853 public static final int COLOR_CORRECTION_MODE_TRANSFORM_MATRIX = 0;
854
855 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700856 * <p>Color correction processing must not slow down
857 * capture rate relative to sensor raw output.</p>
Igor Murashkin7d2a5c52014-01-17 15:07:52 -0800858 * <p>Advanced white balance adjustments above and beyond
859 * the specified white balance pipeline may be applied.</p>
860 * <p>If AWB is enabled with <code>{@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} != OFF</code>, then
861 * the camera device uses the last frame's AWB values
862 * (or defaults if AWB has never been run).</p>
863 *
864 * @see CaptureRequest#CONTROL_AWB_MODE
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700865 * @see CaptureRequest#COLOR_CORRECTION_MODE
866 */
867 public static final int COLOR_CORRECTION_MODE_FAST = 1;
868
869 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700870 * <p>Color correction processing operates at improved
Yin-Chia Yehfba08dd2015-04-02 14:05:14 -0700871 * quality but the capture rate might be reduced (relative to sensor
872 * raw output rate)</p>
Igor Murashkin7d2a5c52014-01-17 15:07:52 -0800873 * <p>Advanced white balance adjustments above and beyond
874 * the specified white balance pipeline may be applied.</p>
875 * <p>If AWB is enabled with <code>{@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} != OFF</code>, then
876 * the camera device uses the last frame's AWB values
877 * (or defaults if AWB has never been run).</p>
878 *
879 * @see CaptureRequest#CONTROL_AWB_MODE
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700880 * @see CaptureRequest#COLOR_CORRECTION_MODE
881 */
882 public static final int COLOR_CORRECTION_MODE_HIGH_QUALITY = 2;
883
884 //
Zhijun He9e4e4392014-08-18 11:12:32 -0700885 // Enumeration values for CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE
Zhijun Hea05e59d2014-07-08 18:27:47 -0700886 //
887
888 /**
889 * <p>No aberration correction is applied.</p>
Zhijun He9e4e4392014-08-18 11:12:32 -0700890 * @see CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE
Zhijun Hea05e59d2014-07-08 18:27:47 -0700891 */
Zhijun He9e4e4392014-08-18 11:12:32 -0700892 public static final int COLOR_CORRECTION_ABERRATION_MODE_OFF = 0;
Zhijun Hea05e59d2014-07-08 18:27:47 -0700893
894 /**
895 * <p>Aberration correction will not slow down capture rate
896 * relative to sensor raw output.</p>
Zhijun He9e4e4392014-08-18 11:12:32 -0700897 * @see CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE
Zhijun Hea05e59d2014-07-08 18:27:47 -0700898 */
Zhijun He9e4e4392014-08-18 11:12:32 -0700899 public static final int COLOR_CORRECTION_ABERRATION_MODE_FAST = 1;
Zhijun Hea05e59d2014-07-08 18:27:47 -0700900
901 /**
Yin-Chia Yehfba08dd2015-04-02 14:05:14 -0700902 * <p>Aberration correction operates at improved quality but the capture rate might be
903 * reduced (relative to sensor raw output rate)</p>
Zhijun He9e4e4392014-08-18 11:12:32 -0700904 * @see CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE
Zhijun Hea05e59d2014-07-08 18:27:47 -0700905 */
Zhijun He9e4e4392014-08-18 11:12:32 -0700906 public static final int COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY = 2;
Zhijun Hea05e59d2014-07-08 18:27:47 -0700907
908 //
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700909 // Enumeration values for CaptureRequest#CONTROL_AE_ANTIBANDING_MODE
910 //
911
912 /**
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -0800913 * <p>The camera device will not adjust exposure duration to
914 * avoid banding problems.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700915 * @see CaptureRequest#CONTROL_AE_ANTIBANDING_MODE
916 */
917 public static final int CONTROL_AE_ANTIBANDING_MODE_OFF = 0;
918
919 /**
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -0800920 * <p>The camera device will adjust exposure duration to
921 * avoid banding problems with 50Hz illumination sources.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700922 * @see CaptureRequest#CONTROL_AE_ANTIBANDING_MODE
923 */
924 public static final int CONTROL_AE_ANTIBANDING_MODE_50HZ = 1;
925
926 /**
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -0800927 * <p>The camera device will adjust exposure duration to
928 * avoid banding problems with 60Hz illumination
929 * sources.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700930 * @see CaptureRequest#CONTROL_AE_ANTIBANDING_MODE
931 */
932 public static final int CONTROL_AE_ANTIBANDING_MODE_60HZ = 2;
933
934 /**
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -0800935 * <p>The camera device will automatically adapt its
936 * antibanding routine to the current illumination
Yin-Chia Yeh7b2cae62014-11-25 11:54:18 -0800937 * condition. This is the default mode if AUTO is
938 * available on given camera device.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700939 * @see CaptureRequest#CONTROL_AE_ANTIBANDING_MODE
940 */
941 public static final int CONTROL_AE_ANTIBANDING_MODE_AUTO = 3;
942
943 //
944 // Enumeration values for CaptureRequest#CONTROL_AE_MODE
945 //
946
947 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700948 * <p>The camera device's autoexposure routine is disabled.</p>
949 * <p>The application-selected {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime},
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -0800950 * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity} and
951 * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} are used by the camera
952 * device, along with android.flash.* fields, if there's
953 * a flash unit for this camera device.</p>
Yin-Chia Yeh7144b5d2014-11-12 11:42:49 -0800954 * <p>Note that auto-white balance (AWB) and auto-focus (AF)
955 * behavior is device dependent when AE is in OFF mode.
956 * To have consistent behavior across different devices,
957 * it is recommended to either set AWB and AF to OFF mode
958 * or lock AWB and AF before setting AE to OFF.
959 * See {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode},
960 * {@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock}, and {@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}
961 * for more details.</p>
Igor Murashkin4b8cd6b2014-10-02 16:00:52 -0700962 * <p>LEGACY devices do not support the OFF mode and will
963 * override attempts to use this value to ON.</p>
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -0800964 *
Yin-Chia Yeh7144b5d2014-11-12 11:42:49 -0800965 * @see CaptureRequest#CONTROL_AF_MODE
966 * @see CaptureRequest#CONTROL_AF_TRIGGER
967 * @see CaptureRequest#CONTROL_AWB_LOCK
968 * @see CaptureRequest#CONTROL_AWB_MODE
Zhijun He5f2a47f2014-01-16 15:44:41 -0800969 * @see CaptureRequest#SENSOR_EXPOSURE_TIME
Eino-Ville Talvala265b34c2014-01-16 16:18:52 -0800970 * @see CaptureRequest#SENSOR_FRAME_DURATION
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -0800971 * @see CaptureRequest#SENSOR_SENSITIVITY
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700972 * @see CaptureRequest#CONTROL_AE_MODE
973 */
974 public static final int CONTROL_AE_MODE_OFF = 0;
975
976 /**
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -0800977 * <p>The camera device's autoexposure routine is active,
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700978 * with no flash control.</p>
979 * <p>The application's values for
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -0800980 * {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime},
981 * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and
982 * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} are ignored. The
983 * application has control over the various
984 * android.flash.* fields.</p>
985 *
Zhijun He5f2a47f2014-01-16 15:44:41 -0800986 * @see CaptureRequest#SENSOR_EXPOSURE_TIME
Eino-Ville Talvala265b34c2014-01-16 16:18:52 -0800987 * @see CaptureRequest#SENSOR_FRAME_DURATION
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -0800988 * @see CaptureRequest#SENSOR_SENSITIVITY
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -0700989 * @see CaptureRequest#CONTROL_AE_MODE
990 */
991 public static final int CONTROL_AE_MODE_ON = 1;
992
993 /**
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -0800994 * <p>Like ON, except that the camera device also controls
995 * the camera's flash unit, firing it in low-light
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -0700996 * conditions.</p>
997 * <p>The flash may be fired during a precapture sequence
998 * (triggered by {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}) and
999 * may be fired for captures for which the
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -08001000 * {@link CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} field is set to
1001 * STILL_CAPTURE</p>
1002 *
Igor Murashkin3242f4f2014-01-15 12:27:41 -08001003 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
Zhijun He5f2a47f2014-01-16 15:44:41 -08001004 * @see CaptureRequest#CONTROL_CAPTURE_INTENT
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001005 * @see CaptureRequest#CONTROL_AE_MODE
1006 */
1007 public static final int CONTROL_AE_MODE_ON_AUTO_FLASH = 2;
1008
1009 /**
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -08001010 * <p>Like ON, except that the camera device also controls
1011 * the camera's flash unit, always firing it for still
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001012 * captures.</p>
1013 * <p>The flash may be fired during a precapture sequence
1014 * (triggered by {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}) and
1015 * will always be fired for captures for which the
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -08001016 * {@link CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} field is set to
1017 * STILL_CAPTURE</p>
1018 *
Igor Murashkin3242f4f2014-01-15 12:27:41 -08001019 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
Zhijun He5f2a47f2014-01-16 15:44:41 -08001020 * @see CaptureRequest#CONTROL_CAPTURE_INTENT
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001021 * @see CaptureRequest#CONTROL_AE_MODE
1022 */
1023 public static final int CONTROL_AE_MODE_ON_ALWAYS_FLASH = 3;
1024
1025 /**
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -08001026 * <p>Like ON_AUTO_FLASH, but with automatic red eye
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001027 * reduction.</p>
1028 * <p>If deemed necessary by the camera device, a red eye
1029 * reduction flash will fire during the precapture
1030 * sequence.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001031 * @see CaptureRequest#CONTROL_AE_MODE
1032 */
1033 public static final int CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE = 4;
1034
1035 //
1036 // Enumeration values for CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
1037 //
1038
1039 /**
Igor Murashkinace5bf02013-12-10 17:36:40 -08001040 * <p>The trigger is idle.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001041 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
1042 */
1043 public static final int CONTROL_AE_PRECAPTURE_TRIGGER_IDLE = 0;
1044
1045 /**
Zhijun He228f4f92014-01-16 17:22:05 -08001046 * <p>The precapture metering sequence will be started
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001047 * by the camera device.</p>
1048 * <p>The exact effect of the precapture trigger depends on
1049 * the current AE mode and state.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001050 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
1051 */
1052 public static final int CONTROL_AE_PRECAPTURE_TRIGGER_START = 1;
1053
Zhijun Hefa95b042015-02-09 10:40:49 -08001054 /**
1055 * <p>The camera device will cancel any currently active or completed
1056 * precapture metering sequence, the auto-exposure routine will return to its
1057 * initial state.</p>
1058 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
1059 */
1060 public static final int CONTROL_AE_PRECAPTURE_TRIGGER_CANCEL = 2;
1061
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001062 //
1063 // Enumeration values for CaptureRequest#CONTROL_AF_MODE
1064 //
1065
1066 /**
Zhijun Hef3537422013-12-16 16:56:35 -08001067 * <p>The auto-focus routine does not control the lens;
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -08001068 * {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} is controlled by the
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001069 * application.</p>
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -08001070 *
1071 * @see CaptureRequest#LENS_FOCUS_DISTANCE
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001072 * @see CaptureRequest#CONTROL_AF_MODE
1073 */
1074 public static final int CONTROL_AF_MODE_OFF = 0;
1075
1076 /**
Eino-Ville Talvalab67a3b32014-06-06 13:07:20 -07001077 * <p>Basic automatic focus mode.</p>
1078 * <p>In this mode, the lens does not move unless
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001079 * the autofocus trigger action is called. When that trigger
Eino-Ville Talvalab67a3b32014-06-06 13:07:20 -07001080 * is activated, AF will transition to ACTIVE_SCAN, then to
Zhijun Hef3537422013-12-16 16:56:35 -08001081 * the outcome of the scan (FOCUSED or NOT_FOCUSED).</p>
Eino-Ville Talvalab67a3b32014-06-06 13:07:20 -07001082 * <p>Always supported if lens is not fixed focus.</p>
1083 * <p>Use {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} to determine if lens
1084 * is fixed-focus.</p>
Zhijun Hef3537422013-12-16 16:56:35 -08001085 * <p>Triggering AF_CANCEL resets the lens position to default,
Igor Murashkinace5bf02013-12-10 17:36:40 -08001086 * and sets the AF state to INACTIVE.</p>
Eino-Ville Talvala0da8bf52014-01-08 16:18:35 -08001087 *
1088 * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001089 * @see CaptureRequest#CONTROL_AF_MODE
1090 */
1091 public static final int CONTROL_AF_MODE_AUTO = 1;
1092
1093 /**
Eino-Ville Talvalab67a3b32014-06-06 13:07:20 -07001094 * <p>Close-up focusing mode.</p>
Igor Murashkinace5bf02013-12-10 17:36:40 -08001095 * <p>In this mode, the lens does not move unless the
Eino-Ville Talvalab67a3b32014-06-06 13:07:20 -07001096 * autofocus trigger action is called. When that trigger is
1097 * activated, AF will transition to ACTIVE_SCAN, then to
1098 * the outcome of the scan (FOCUSED or NOT_FOCUSED). This
1099 * mode is optimized for focusing on objects very close to
1100 * the camera.</p>
1101 * <p>When that trigger is activated, AF will transition to
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001102 * ACTIVE_SCAN, then to the outcome of the scan (FOCUSED or
Eino-Ville Talvalab67a3b32014-06-06 13:07:20 -07001103 * NOT_FOCUSED). Triggering cancel AF resets the lens
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001104 * position to default, and sets the AF state to
Igor Murashkinace5bf02013-12-10 17:36:40 -08001105 * INACTIVE.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001106 * @see CaptureRequest#CONTROL_AF_MODE
1107 */
1108 public static final int CONTROL_AF_MODE_MACRO = 2;
1109
1110 /**
Igor Murashkinace5bf02013-12-10 17:36:40 -08001111 * <p>In this mode, the AF algorithm modifies the lens
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001112 * position continually to attempt to provide a
Igor Murashkinace5bf02013-12-10 17:36:40 -08001113 * constantly-in-focus image stream.</p>
1114 * <p>The focusing behavior should be suitable for good quality
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001115 * video recording; typically this means slower focus
1116 * movement and no overshoots. When the AF trigger is not
1117 * involved, the AF algorithm should start in INACTIVE state,
1118 * and then transition into PASSIVE_SCAN and PASSIVE_FOCUSED
1119 * states as appropriate. When the AF trigger is activated,
1120 * the algorithm should immediately transition into
1121 * AF_FOCUSED or AF_NOT_FOCUSED as appropriate, and lock the
Igor Murashkinace5bf02013-12-10 17:36:40 -08001122 * lens position until a cancel AF trigger is received.</p>
1123 * <p>Once cancel is received, the algorithm should transition
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001124 * back to INACTIVE and resume passive scan. Note that this
1125 * behavior is not identical to CONTINUOUS_PICTURE, since an
1126 * ongoing PASSIVE_SCAN must immediately be
Igor Murashkinace5bf02013-12-10 17:36:40 -08001127 * canceled.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001128 * @see CaptureRequest#CONTROL_AF_MODE
1129 */
1130 public static final int CONTROL_AF_MODE_CONTINUOUS_VIDEO = 3;
1131
1132 /**
Igor Murashkinace5bf02013-12-10 17:36:40 -08001133 * <p>In this mode, the AF algorithm modifies the lens
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001134 * position continually to attempt to provide a
Igor Murashkinace5bf02013-12-10 17:36:40 -08001135 * constantly-in-focus image stream.</p>
1136 * <p>The focusing behavior should be suitable for still image
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001137 * capture; typically this means focusing as fast as
1138 * possible. When the AF trigger is not involved, the AF
1139 * algorithm should start in INACTIVE state, and then
1140 * transition into PASSIVE_SCAN and PASSIVE_FOCUSED states as
1141 * appropriate as it attempts to maintain focus. When the AF
1142 * trigger is activated, the algorithm should finish its
1143 * PASSIVE_SCAN if active, and then transition into
1144 * AF_FOCUSED or AF_NOT_FOCUSED as appropriate, and lock the
Igor Murashkinace5bf02013-12-10 17:36:40 -08001145 * lens position until a cancel AF trigger is received.</p>
1146 * <p>When the AF cancel trigger is activated, the algorithm
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001147 * should transition back to INACTIVE and then act as if it
Igor Murashkinace5bf02013-12-10 17:36:40 -08001148 * has just been started.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001149 * @see CaptureRequest#CONTROL_AF_MODE
1150 */
1151 public static final int CONTROL_AF_MODE_CONTINUOUS_PICTURE = 4;
1152
1153 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001154 * <p>Extended depth of field (digital focus) mode.</p>
1155 * <p>The camera device will produce images with an extended
1156 * depth of field automatically; no special focusing
1157 * operations need to be done before taking a picture.</p>
1158 * <p>AF triggers are ignored, and the AF state will always be
Igor Murashkinace5bf02013-12-10 17:36:40 -08001159 * INACTIVE.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001160 * @see CaptureRequest#CONTROL_AF_MODE
1161 */
1162 public static final int CONTROL_AF_MODE_EDOF = 5;
1163
1164 //
1165 // Enumeration values for CaptureRequest#CONTROL_AF_TRIGGER
1166 //
1167
1168 /**
Igor Murashkinace5bf02013-12-10 17:36:40 -08001169 * <p>The trigger is idle.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001170 * @see CaptureRequest#CONTROL_AF_TRIGGER
1171 */
1172 public static final int CONTROL_AF_TRIGGER_IDLE = 0;
1173
1174 /**
Zhijun He228f4f92014-01-16 17:22:05 -08001175 * <p>Autofocus will trigger now.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001176 * @see CaptureRequest#CONTROL_AF_TRIGGER
1177 */
1178 public static final int CONTROL_AF_TRIGGER_START = 1;
1179
1180 /**
Zhijun He228f4f92014-01-16 17:22:05 -08001181 * <p>Autofocus will return to its initial
1182 * state, and cancel any currently active trigger.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001183 * @see CaptureRequest#CONTROL_AF_TRIGGER
1184 */
1185 public static final int CONTROL_AF_TRIGGER_CANCEL = 2;
1186
1187 //
1188 // Enumeration values for CaptureRequest#CONTROL_AWB_MODE
1189 //
1190
1191 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001192 * <p>The camera device's auto-white balance routine is disabled.</p>
1193 * <p>The application-selected color transform matrix
Zhijun He399f05d2014-01-15 11:31:30 -08001194 * ({@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}) and gains
1195 * ({@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains}) are used by the camera
1196 * device for manual white balance control.</p>
1197 *
Zhijun He399f05d2014-01-15 11:31:30 -08001198 * @see CaptureRequest#COLOR_CORRECTION_GAINS
Eino-Ville Talvala265b34c2014-01-16 16:18:52 -08001199 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001200 * @see CaptureRequest#CONTROL_AWB_MODE
1201 */
1202 public static final int CONTROL_AWB_MODE_OFF = 0;
1203
1204 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001205 * <p>The camera device's auto-white balance routine is active.</p>
1206 * <p>The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}
1207 * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} are ignored.
1208 * For devices that support the MANUAL_POST_PROCESSING capability, the
1209 * values used by the camera device for the transform and gains
1210 * will be available in the capture result for this request.</p>
Zhijun He399f05d2014-01-15 11:31:30 -08001211 *
1212 * @see CaptureRequest#COLOR_CORRECTION_GAINS
Eino-Ville Talvalad8fd6792014-02-10 12:41:04 -08001213 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001214 * @see CaptureRequest#CONTROL_AWB_MODE
1215 */
1216 public static final int CONTROL_AWB_MODE_AUTO = 1;
1217
1218 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001219 * <p>The camera device's auto-white balance routine is disabled;
Zhijun He399f05d2014-01-15 11:31:30 -08001220 * the camera device uses incandescent light as the assumed scene
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001221 * illumination for white balance.</p>
1222 * <p>While the exact white balance transforms are up to the
1223 * camera device, they will approximately match the CIE
1224 * standard illuminant A.</p>
1225 * <p>The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}
1226 * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} are ignored.
1227 * For devices that support the MANUAL_POST_PROCESSING capability, the
1228 * values used by the camera device for the transform and gains
1229 * will be available in the capture result for this request.</p>
1230 *
1231 * @see CaptureRequest#COLOR_CORRECTION_GAINS
1232 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001233 * @see CaptureRequest#CONTROL_AWB_MODE
1234 */
1235 public static final int CONTROL_AWB_MODE_INCANDESCENT = 2;
1236
1237 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001238 * <p>The camera device's auto-white balance routine is disabled;
Zhijun He399f05d2014-01-15 11:31:30 -08001239 * the camera device uses fluorescent light as the assumed scene
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001240 * illumination for white balance.</p>
1241 * <p>While the exact white balance transforms are up to the
1242 * camera device, they will approximately match the CIE
1243 * standard illuminant F2.</p>
1244 * <p>The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}
1245 * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} are ignored.
1246 * For devices that support the MANUAL_POST_PROCESSING capability, the
1247 * values used by the camera device for the transform and gains
1248 * will be available in the capture result for this request.</p>
1249 *
1250 * @see CaptureRequest#COLOR_CORRECTION_GAINS
1251 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001252 * @see CaptureRequest#CONTROL_AWB_MODE
1253 */
1254 public static final int CONTROL_AWB_MODE_FLUORESCENT = 3;
1255
1256 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001257 * <p>The camera device's auto-white balance routine is disabled;
Zhijun He399f05d2014-01-15 11:31:30 -08001258 * the camera device uses warm fluorescent light as the assumed scene
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001259 * illumination for white balance.</p>
1260 * <p>While the exact white balance transforms are up to the
1261 * camera device, they will approximately match the CIE
1262 * standard illuminant F4.</p>
1263 * <p>The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}
1264 * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} are ignored.
1265 * For devices that support the MANUAL_POST_PROCESSING capability, the
1266 * values used by the camera device for the transform and gains
1267 * will be available in the capture result for this request.</p>
1268 *
1269 * @see CaptureRequest#COLOR_CORRECTION_GAINS
1270 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001271 * @see CaptureRequest#CONTROL_AWB_MODE
1272 */
1273 public static final int CONTROL_AWB_MODE_WARM_FLUORESCENT = 4;
1274
1275 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001276 * <p>The camera device's auto-white balance routine is disabled;
Zhijun He399f05d2014-01-15 11:31:30 -08001277 * the camera device uses daylight light as the assumed scene
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001278 * illumination for white balance.</p>
1279 * <p>While the exact white balance transforms are up to the
1280 * camera device, they will approximately match the CIE
1281 * standard illuminant D65.</p>
1282 * <p>The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}
1283 * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} are ignored.
1284 * For devices that support the MANUAL_POST_PROCESSING capability, the
1285 * values used by the camera device for the transform and gains
1286 * will be available in the capture result for this request.</p>
1287 *
1288 * @see CaptureRequest#COLOR_CORRECTION_GAINS
1289 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001290 * @see CaptureRequest#CONTROL_AWB_MODE
1291 */
1292 public static final int CONTROL_AWB_MODE_DAYLIGHT = 5;
1293
1294 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001295 * <p>The camera device's auto-white balance routine is disabled;
Zhijun He399f05d2014-01-15 11:31:30 -08001296 * the camera device uses cloudy daylight light as the assumed scene
1297 * illumination for white balance.</p>
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001298 * <p>The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}
1299 * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} are ignored.
1300 * For devices that support the MANUAL_POST_PROCESSING capability, the
1301 * values used by the camera device for the transform and gains
1302 * will be available in the capture result for this request.</p>
1303 *
1304 * @see CaptureRequest#COLOR_CORRECTION_GAINS
1305 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001306 * @see CaptureRequest#CONTROL_AWB_MODE
1307 */
1308 public static final int CONTROL_AWB_MODE_CLOUDY_DAYLIGHT = 6;
1309
1310 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001311 * <p>The camera device's auto-white balance routine is disabled;
Zhijun He399f05d2014-01-15 11:31:30 -08001312 * the camera device uses twilight light as the assumed scene
1313 * illumination for white balance.</p>
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001314 * <p>The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}
1315 * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} are ignored.
1316 * For devices that support the MANUAL_POST_PROCESSING capability, the
1317 * values used by the camera device for the transform and gains
1318 * will be available in the capture result for this request.</p>
1319 *
1320 * @see CaptureRequest#COLOR_CORRECTION_GAINS
1321 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001322 * @see CaptureRequest#CONTROL_AWB_MODE
1323 */
1324 public static final int CONTROL_AWB_MODE_TWILIGHT = 7;
1325
1326 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001327 * <p>The camera device's auto-white balance routine is disabled;
Zhijun He399f05d2014-01-15 11:31:30 -08001328 * the camera device uses shade light as the assumed scene
1329 * illumination for white balance.</p>
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001330 * <p>The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}
1331 * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} are ignored.
1332 * For devices that support the MANUAL_POST_PROCESSING capability, the
1333 * values used by the camera device for the transform and gains
1334 * will be available in the capture result for this request.</p>
1335 *
1336 * @see CaptureRequest#COLOR_CORRECTION_GAINS
1337 * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001338 * @see CaptureRequest#CONTROL_AWB_MODE
1339 */
1340 public static final int CONTROL_AWB_MODE_SHADE = 8;
1341
1342 //
1343 // Enumeration values for CaptureRequest#CONTROL_CAPTURE_INTENT
1344 //
1345
1346 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001347 * <p>The goal of this request doesn't fall into the other
1348 * categories. The camera device will default to preview-like
Igor Murashkinace5bf02013-12-10 17:36:40 -08001349 * behavior.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001350 * @see CaptureRequest#CONTROL_CAPTURE_INTENT
1351 */
1352 public static final int CONTROL_CAPTURE_INTENT_CUSTOM = 0;
1353
1354 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001355 * <p>This request is for a preview-like use case.</p>
1356 * <p>The precapture trigger may be used to start off a metering
1357 * w/flash sequence.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001358 * @see CaptureRequest#CONTROL_CAPTURE_INTENT
1359 */
1360 public static final int CONTROL_CAPTURE_INTENT_PREVIEW = 1;
1361
1362 /**
Igor Murashkinace5bf02013-12-10 17:36:40 -08001363 * <p>This request is for a still capture-type
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001364 * use case.</p>
1365 * <p>If the flash unit is under automatic control, it may fire as needed.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001366 * @see CaptureRequest#CONTROL_CAPTURE_INTENT
1367 */
1368 public static final int CONTROL_CAPTURE_INTENT_STILL_CAPTURE = 2;
1369
1370 /**
Igor Murashkinace5bf02013-12-10 17:36:40 -08001371 * <p>This request is for a video recording
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001372 * use case.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001373 * @see CaptureRequest#CONTROL_CAPTURE_INTENT
1374 */
1375 public static final int CONTROL_CAPTURE_INTENT_VIDEO_RECORD = 3;
1376
1377 /**
Igor Murashkinace5bf02013-12-10 17:36:40 -08001378 * <p>This request is for a video snapshot (still
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001379 * image while recording video) use case.</p>
1380 * <p>The camera device should take the highest-quality image
1381 * possible (given the other settings) without disrupting the
Eino-Ville Talvala126a7462014-11-04 16:31:01 -08001382 * frame rate of video recording. </p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001383 * @see CaptureRequest#CONTROL_CAPTURE_INTENT
1384 */
1385 public static final int CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT = 4;
1386
1387 /**
Igor Murashkinace5bf02013-12-10 17:36:40 -08001388 * <p>This request is for a ZSL usecase; the
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001389 * application will stream full-resolution images and
1390 * reprocess one or several later for a final
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001391 * capture.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001392 * @see CaptureRequest#CONTROL_CAPTURE_INTENT
1393 */
1394 public static final int CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG = 5;
1395
Zhijun Hee30adb72014-04-09 19:04:31 -07001396 /**
1397 * <p>This request is for manual capture use case where
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001398 * the applications want to directly control the capture parameters.</p>
1399 * <p>For example, the application may wish to manually control
1400 * {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, etc.</p>
Zhijun Hee30adb72014-04-09 19:04:31 -07001401 *
1402 * @see CaptureRequest#SENSOR_EXPOSURE_TIME
1403 * @see CaptureRequest#SENSOR_SENSITIVITY
1404 * @see CaptureRequest#CONTROL_CAPTURE_INTENT
1405 */
1406 public static final int CONTROL_CAPTURE_INTENT_MANUAL = 6;
1407
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001408 //
1409 // Enumeration values for CaptureRequest#CONTROL_EFFECT_MODE
1410 //
1411
1412 /**
Ruben Brunk5f1dcfe2014-01-17 16:42:51 -08001413 * <p>No color effect will be applied.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001414 * @see CaptureRequest#CONTROL_EFFECT_MODE
1415 */
1416 public static final int CONTROL_EFFECT_MODE_OFF = 0;
1417
1418 /**
Ruben Brunk5f1dcfe2014-01-17 16:42:51 -08001419 * <p>A "monocolor" effect where the image is mapped into
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001420 * a single color.</p>
1421 * <p>This will typically be grayscale.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001422 * @see CaptureRequest#CONTROL_EFFECT_MODE
1423 */
1424 public static final int CONTROL_EFFECT_MODE_MONO = 1;
1425
1426 /**
Ruben Brunk5f1dcfe2014-01-17 16:42:51 -08001427 * <p>A "photo-negative" effect where the image's colors
1428 * are inverted.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001429 * @see CaptureRequest#CONTROL_EFFECT_MODE
1430 */
1431 public static final int CONTROL_EFFECT_MODE_NEGATIVE = 2;
1432
1433 /**
Ruben Brunk5f1dcfe2014-01-17 16:42:51 -08001434 * <p>A "solarisation" effect (Sabattier effect) where the
1435 * image is wholly or partially reversed in
1436 * tone.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001437 * @see CaptureRequest#CONTROL_EFFECT_MODE
1438 */
1439 public static final int CONTROL_EFFECT_MODE_SOLARIZE = 3;
1440
1441 /**
Ruben Brunk5f1dcfe2014-01-17 16:42:51 -08001442 * <p>A "sepia" effect where the image is mapped into warm
1443 * gray, red, and brown tones.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001444 * @see CaptureRequest#CONTROL_EFFECT_MODE
1445 */
1446 public static final int CONTROL_EFFECT_MODE_SEPIA = 4;
1447
1448 /**
Ruben Brunk5f1dcfe2014-01-17 16:42:51 -08001449 * <p>A "posterization" effect where the image uses
1450 * discrete regions of tone rather than a continuous
1451 * gradient of tones.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001452 * @see CaptureRequest#CONTROL_EFFECT_MODE
1453 */
1454 public static final int CONTROL_EFFECT_MODE_POSTERIZE = 5;
1455
1456 /**
Ruben Brunk5f1dcfe2014-01-17 16:42:51 -08001457 * <p>A "whiteboard" effect where the image is typically displayed
1458 * as regions of white, with black or grey details.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001459 * @see CaptureRequest#CONTROL_EFFECT_MODE
1460 */
1461 public static final int CONTROL_EFFECT_MODE_WHITEBOARD = 6;
1462
1463 /**
Ruben Brunk5f1dcfe2014-01-17 16:42:51 -08001464 * <p>A "blackboard" effect where the image is typically displayed
1465 * as regions of black, with white or grey details.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001466 * @see CaptureRequest#CONTROL_EFFECT_MODE
1467 */
1468 public static final int CONTROL_EFFECT_MODE_BLACKBOARD = 7;
1469
1470 /**
Ruben Brunk5f1dcfe2014-01-17 16:42:51 -08001471 * <p>An "aqua" effect where a blue hue is added to the image.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001472 * @see CaptureRequest#CONTROL_EFFECT_MODE
1473 */
1474 public static final int CONTROL_EFFECT_MODE_AQUA = 8;
1475
1476 //
1477 // Enumeration values for CaptureRequest#CONTROL_MODE
1478 //
1479
1480 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001481 * <p>Full application control of pipeline.</p>
1482 * <p>All control by the device's metering and focusing (3A)
1483 * routines is disabled, and no other settings in
1484 * android.control.* have any effect, except that
1485 * {@link CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} may be used by the camera
1486 * device to select post-processing values for processing
1487 * blocks that do not allow for manual control, or are not
1488 * exposed by the camera API.</p>
1489 * <p>However, the camera device's 3A routines may continue to
1490 * collect statistics and update their internal state so that
1491 * when control is switched to AUTO mode, good control values
1492 * can be immediately applied.</p>
1493 *
1494 * @see CaptureRequest#CONTROL_CAPTURE_INTENT
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001495 * @see CaptureRequest#CONTROL_MODE
1496 */
1497 public static final int CONTROL_MODE_OFF = 0;
1498
1499 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001500 * <p>Use settings for each individual 3A routine.</p>
1501 * <p>Manual control of capture parameters is disabled. All
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001502 * controls in android.control.* besides sceneMode take
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001503 * effect.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001504 * @see CaptureRequest#CONTROL_MODE
1505 */
1506 public static final int CONTROL_MODE_AUTO = 1;
1507
1508 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001509 * <p>Use a specific scene mode.</p>
1510 * <p>Enabling this disables control.aeMode, control.awbMode and
1511 * control.afMode controls; the camera device will ignore
1512 * those settings while USE_SCENE_MODE is active (except for
1513 * FACE_PRIORITY scene mode). Other control entries are still
1514 * active. This setting can only be used if scene mode is
1515 * supported (i.e. {@link CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES android.control.availableSceneModes}
1516 * contain some modes other than DISABLED).</p>
Zhijun Hea4866242014-03-27 23:51:34 -07001517 *
1518 * @see CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001519 * @see CaptureRequest#CONTROL_MODE
1520 */
1521 public static final int CONTROL_MODE_USE_SCENE_MODE = 2;
1522
Zhijun He2d5e8972014-02-07 16:13:46 -08001523 /**
1524 * <p>Same as OFF mode, except that this capture will not be
1525 * used by camera device background auto-exposure, auto-white balance and
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001526 * auto-focus algorithms (3A) to update their statistics.</p>
1527 * <p>Specifically, the 3A routines are locked to the last
1528 * values set from a request with AUTO, OFF, or
1529 * USE_SCENE_MODE, and any statistics or state updates
1530 * collected from manual captures with OFF_KEEP_STATE will be
1531 * discarded by the camera device.</p>
Zhijun He2d5e8972014-02-07 16:13:46 -08001532 * @see CaptureRequest#CONTROL_MODE
1533 */
1534 public static final int CONTROL_MODE_OFF_KEEP_STATE = 3;
1535
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001536 //
1537 // Enumeration values for CaptureRequest#CONTROL_SCENE_MODE
1538 //
1539
1540 /**
Ruben Brunke6679362014-01-17 17:05:54 -08001541 * <p>Indicates that no scene modes are set for a given capture request.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001542 * @see CaptureRequest#CONTROL_SCENE_MODE
1543 */
Ruben Brunke6679362014-01-17 17:05:54 -08001544 public static final int CONTROL_SCENE_MODE_DISABLED = 0;
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001545
1546 /**
Ruben Brunke6679362014-01-17 17:05:54 -08001547 * <p>If face detection support exists, use face
1548 * detection data for auto-focus, auto-white balance, and
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001549 * auto-exposure routines.</p>
1550 * <p>If face detection statistics are disabled
1551 * (i.e. {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} is set to OFF),
Ruben Brunke6679362014-01-17 17:05:54 -08001552 * this should still operate correctly (but will not return
1553 * face detection statistics to the framework).</p>
1554 * <p>Unlike the other scene modes, {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode},
Eino-Ville Talvalad8fd6792014-02-10 12:41:04 -08001555 * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, and {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}
Ruben Brunke6679362014-01-17 17:05:54 -08001556 * remain active when FACE_PRIORITY is set.</p>
1557 *
1558 * @see CaptureRequest#CONTROL_AE_MODE
Eino-Ville Talvalad8fd6792014-02-10 12:41:04 -08001559 * @see CaptureRequest#CONTROL_AF_MODE
Ruben Brunke6679362014-01-17 17:05:54 -08001560 * @see CaptureRequest#CONTROL_AWB_MODE
1561 * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001562 * @see CaptureRequest#CONTROL_SCENE_MODE
1563 */
1564 public static final int CONTROL_SCENE_MODE_FACE_PRIORITY = 1;
1565
1566 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001567 * <p>Optimized for photos of quickly moving objects.</p>
1568 * <p>Similar to SPORTS.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001569 * @see CaptureRequest#CONTROL_SCENE_MODE
1570 */
1571 public static final int CONTROL_SCENE_MODE_ACTION = 2;
1572
1573 /**
Ruben Brunke6679362014-01-17 17:05:54 -08001574 * <p>Optimized for still photos of people.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001575 * @see CaptureRequest#CONTROL_SCENE_MODE
1576 */
1577 public static final int CONTROL_SCENE_MODE_PORTRAIT = 3;
1578
1579 /**
Ruben Brunke6679362014-01-17 17:05:54 -08001580 * <p>Optimized for photos of distant macroscopic objects.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001581 * @see CaptureRequest#CONTROL_SCENE_MODE
1582 */
1583 public static final int CONTROL_SCENE_MODE_LANDSCAPE = 4;
1584
1585 /**
Ruben Brunke6679362014-01-17 17:05:54 -08001586 * <p>Optimized for low-light settings.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001587 * @see CaptureRequest#CONTROL_SCENE_MODE
1588 */
1589 public static final int CONTROL_SCENE_MODE_NIGHT = 5;
1590
1591 /**
Ruben Brunke6679362014-01-17 17:05:54 -08001592 * <p>Optimized for still photos of people in low-light
1593 * settings.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001594 * @see CaptureRequest#CONTROL_SCENE_MODE
1595 */
1596 public static final int CONTROL_SCENE_MODE_NIGHT_PORTRAIT = 6;
1597
1598 /**
Ruben Brunke6679362014-01-17 17:05:54 -08001599 * <p>Optimized for dim, indoor settings where flash must
1600 * remain off.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001601 * @see CaptureRequest#CONTROL_SCENE_MODE
1602 */
1603 public static final int CONTROL_SCENE_MODE_THEATRE = 7;
1604
1605 /**
Ruben Brunke6679362014-01-17 17:05:54 -08001606 * <p>Optimized for bright, outdoor beach settings.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001607 * @see CaptureRequest#CONTROL_SCENE_MODE
1608 */
1609 public static final int CONTROL_SCENE_MODE_BEACH = 8;
1610
1611 /**
Ruben Brunke6679362014-01-17 17:05:54 -08001612 * <p>Optimized for bright, outdoor settings containing snow.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001613 * @see CaptureRequest#CONTROL_SCENE_MODE
1614 */
1615 public static final int CONTROL_SCENE_MODE_SNOW = 9;
1616
1617 /**
Ruben Brunke6679362014-01-17 17:05:54 -08001618 * <p>Optimized for scenes of the setting sun.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001619 * @see CaptureRequest#CONTROL_SCENE_MODE
1620 */
1621 public static final int CONTROL_SCENE_MODE_SUNSET = 10;
1622
1623 /**
Ruben Brunke6679362014-01-17 17:05:54 -08001624 * <p>Optimized to avoid blurry photos due to small amounts of
1625 * device motion (for example: due to hand shake).</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001626 * @see CaptureRequest#CONTROL_SCENE_MODE
1627 */
1628 public static final int CONTROL_SCENE_MODE_STEADYPHOTO = 11;
1629
1630 /**
Ruben Brunke6679362014-01-17 17:05:54 -08001631 * <p>Optimized for nighttime photos of fireworks.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001632 * @see CaptureRequest#CONTROL_SCENE_MODE
1633 */
1634 public static final int CONTROL_SCENE_MODE_FIREWORKS = 12;
1635
1636 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001637 * <p>Optimized for photos of quickly moving people.</p>
1638 * <p>Similar to ACTION.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001639 * @see CaptureRequest#CONTROL_SCENE_MODE
1640 */
1641 public static final int CONTROL_SCENE_MODE_SPORTS = 13;
1642
1643 /**
Ruben Brunke6679362014-01-17 17:05:54 -08001644 * <p>Optimized for dim, indoor settings with multiple moving
1645 * people.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001646 * @see CaptureRequest#CONTROL_SCENE_MODE
1647 */
1648 public static final int CONTROL_SCENE_MODE_PARTY = 14;
1649
1650 /**
Ruben Brunke6679362014-01-17 17:05:54 -08001651 * <p>Optimized for dim settings where the main light source
1652 * is a flame.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001653 * @see CaptureRequest#CONTROL_SCENE_MODE
1654 */
1655 public static final int CONTROL_SCENE_MODE_CANDLELIGHT = 15;
1656
1657 /**
Ruben Brunke6679362014-01-17 17:05:54 -08001658 * <p>Optimized for accurately capturing a photo of barcode
1659 * for use by camera applications that wish to read the
1660 * barcode value.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001661 * @see CaptureRequest#CONTROL_SCENE_MODE
1662 */
1663 public static final int CONTROL_SCENE_MODE_BARCODE = 16;
1664
Zhijun Hee0404182014-06-26 13:17:09 -07001665 /**
1666 * <p>Optimized for high speed video recording (frame rate &gt;=60fps) use case.</p>
1667 * <p>The supported high speed video sizes and fps ranges are specified in
1668 * android.control.availableHighSpeedVideoConfigurations. To get desired
1669 * output frame rates, the application is only allowed to select video size
1670 * and fps range combinations listed in this static metadata. The fps range
1671 * can be control via {@link CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE android.control.aeTargetFpsRange}.</p>
1672 * <p>In this mode, the camera device will override aeMode, awbMode, and afMode to
1673 * ON, ON, and CONTINUOUS_VIDEO, respectively. All post-processing block mode
1674 * controls will be overridden to be FAST. Therefore, no manual control of capture
1675 * and post-processing parameters is possible. All other controls operate the
1676 * same as when {@link CaptureRequest#CONTROL_MODE android.control.mode} == AUTO. This means that all other
1677 * android.control.* fields continue to work, such as</p>
1678 * <ul>
1679 * <li>{@link CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE android.control.aeTargetFpsRange}</li>
1680 * <li>{@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation}</li>
1681 * <li>{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock}</li>
1682 * <li>{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock}</li>
1683 * <li>{@link CaptureRequest#CONTROL_EFFECT_MODE android.control.effectMode}</li>
1684 * <li>{@link CaptureRequest#CONTROL_AE_REGIONS android.control.aeRegions}</li>
1685 * <li>{@link CaptureRequest#CONTROL_AF_REGIONS android.control.afRegions}</li>
1686 * <li>{@link CaptureRequest#CONTROL_AWB_REGIONS android.control.awbRegions}</li>
1687 * <li>{@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}</li>
1688 * <li>{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}</li>
1689 * </ul>
1690 * <p>Outside of android.control.*, the following controls will work:</p>
1691 * <ul>
1692 * <li>{@link CaptureRequest#FLASH_MODE android.flash.mode} (automatic flash for still capture will not work since aeMode is ON)</li>
1693 * <li>{@link CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE android.lens.opticalStabilizationMode} (if it is supported)</li>
1694 * <li>{@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}</li>
1695 * <li>{@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode}</li>
1696 * </ul>
1697 * <p>For high speed recording use case, the actual maximum supported frame rate may
1698 * be lower than what camera can output, depending on the destination Surfaces for
1699 * the image data. For example, if the destination surface is from video encoder,
1700 * the application need check if the video encoder is capable of supporting the
1701 * high frame rate for a given video size, or it will end up with lower recording
1702 * frame rate. If the destination surface is from preview window, the preview frame
1703 * rate will be bounded by the screen refresh rate.</p>
1704 * <p>The camera device will only support up to 2 output high speed streams
1705 * (processed non-stalling format defined in android.request.maxNumOutputStreams)
1706 * in this mode. This control will be effective only if all of below conditions are true:</p>
1707 * <ul>
1708 * <li>The application created no more than maxNumHighSpeedStreams processed non-stalling
1709 * format output streams, where maxNumHighSpeedStreams is calculated as
1710 * min(2, android.request.maxNumOutputStreams[Processed (but not-stalling)]).</li>
1711 * <li>The stream sizes are selected from the sizes reported by
1712 * android.control.availableHighSpeedVideoConfigurations.</li>
1713 * <li>No processed non-stalling or raw streams are configured.</li>
1714 * </ul>
1715 * <p>When above conditions are NOT satistied, the controls of this mode and
1716 * {@link CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE android.control.aeTargetFpsRange} will be ignored by the camera device,
1717 * the camera device will fall back to {@link CaptureRequest#CONTROL_MODE android.control.mode} <code>==</code> AUTO,
1718 * and the returned capture result metadata will give the fps range choosen
1719 * by the camera device.</p>
1720 * <p>Switching into or out of this mode may trigger some camera ISP/sensor
1721 * reconfigurations, which may introduce extra latency. It is recommended that
1722 * the application avoids unnecessary scene mode switch as much as possible.</p>
1723 *
1724 * @see CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION
1725 * @see CaptureRequest#CONTROL_AE_LOCK
1726 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
1727 * @see CaptureRequest#CONTROL_AE_REGIONS
1728 * @see CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE
1729 * @see CaptureRequest#CONTROL_AF_REGIONS
1730 * @see CaptureRequest#CONTROL_AF_TRIGGER
1731 * @see CaptureRequest#CONTROL_AWB_LOCK
1732 * @see CaptureRequest#CONTROL_AWB_REGIONS
1733 * @see CaptureRequest#CONTROL_EFFECT_MODE
1734 * @see CaptureRequest#CONTROL_MODE
1735 * @see CaptureRequest#FLASH_MODE
1736 * @see CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE
1737 * @see CaptureRequest#SCALER_CROP_REGION
1738 * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE
1739 * @see CaptureRequest#CONTROL_SCENE_MODE
1740 */
1741 public static final int CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO = 17;
1742
Ruben Brunkff99a0a2014-08-28 18:42:35 -07001743 /**
Eino-Ville Talvalaf4eac122014-12-05 11:10:15 -08001744 * <p>Turn on a device-specific high dynamic range (HDR) mode.</p>
1745 * <p>In this scene mode, the camera device captures images
1746 * that keep a larger range of scene illumination levels
1747 * visible in the final image. For example, when taking a
1748 * picture of a object in front of a bright window, both
1749 * the object and the scene through the window may be
1750 * visible when using HDR mode, while in normal AUTO mode,
1751 * one or the other may be poorly exposed. As a tradeoff,
1752 * HDR mode generally takes much longer to capture a single
1753 * image, has no user control, and may have other artifacts
1754 * depending on the HDR method used.</p>
1755 * <p>Therefore, HDR captures operate at a much slower rate
1756 * than regular captures.</p>
1757 * <p>In this mode, on LIMITED or FULL devices, when a request
1758 * is made with a {@link CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} of
1759 * STILL_CAPTURE, the camera device will capture an image
1760 * using a high dynamic range capture technique. On LEGACY
1761 * devices, captures that target a JPEG-format output will
1762 * be captured with HDR, and the capture intent is not
1763 * relevant.</p>
1764 * <p>The HDR capture may involve the device capturing a burst
1765 * of images internally and combining them into one, or it
1766 * may involve the device using specialized high dynamic
1767 * range capture hardware. In all cases, a single image is
1768 * produced in response to a capture request submitted
1769 * while in HDR mode.</p>
1770 * <p>Since substantial post-processing is generally needed to
1771 * produce an HDR image, only YUV and JPEG outputs are
1772 * supported for LIMITED/FULL device HDR captures, and only
1773 * JPEG outputs are supported for LEGACY HDR
1774 * captures. Using a RAW output for HDR capture is not
1775 * supported.</p>
1776 *
1777 * @see CaptureRequest#CONTROL_CAPTURE_INTENT
Ruben Brunkff99a0a2014-08-28 18:42:35 -07001778 * @see CaptureRequest#CONTROL_SCENE_MODE
Ruben Brunkff99a0a2014-08-28 18:42:35 -07001779 */
1780 public static final int CONTROL_SCENE_MODE_HDR = 18;
1781
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001782 //
Zhijun He4793af52014-05-05 10:39:12 -07001783 // Enumeration values for CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE
1784 //
1785
1786 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001787 * <p>Video stabilization is disabled.</p>
Zhijun He4793af52014-05-05 10:39:12 -07001788 * @see CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE
1789 */
1790 public static final int CONTROL_VIDEO_STABILIZATION_MODE_OFF = 0;
1791
1792 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001793 * <p>Video stabilization is enabled.</p>
Zhijun He4793af52014-05-05 10:39:12 -07001794 * @see CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE
1795 */
1796 public static final int CONTROL_VIDEO_STABILIZATION_MODE_ON = 1;
1797
1798 //
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001799 // Enumeration values for CaptureRequest#EDGE_MODE
1800 //
1801
1802 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001803 * <p>No edge enhancement is applied.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001804 * @see CaptureRequest#EDGE_MODE
1805 */
1806 public static final int EDGE_MODE_OFF = 0;
1807
1808 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001809 * <p>Apply edge enhancement at a quality level that does not slow down frame rate relative to sensor
Zhijun He28079362013-12-17 10:35:40 -08001810 * output</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001811 * @see CaptureRequest#EDGE_MODE
1812 */
1813 public static final int EDGE_MODE_FAST = 1;
1814
1815 /**
Yin-Chia Yehfba08dd2015-04-02 14:05:14 -07001816 * <p>Apply high-quality edge enhancement, at a cost of possibly reduced output frame rate.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001817 * @see CaptureRequest#EDGE_MODE
1818 */
1819 public static final int EDGE_MODE_HIGH_QUALITY = 2;
1820
1821 //
1822 // Enumeration values for CaptureRequest#FLASH_MODE
1823 //
1824
1825 /**
Zhijun He66d065a2014-01-16 18:18:50 -08001826 * <p>Do not fire the flash for this capture.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001827 * @see CaptureRequest#FLASH_MODE
1828 */
1829 public static final int FLASH_MODE_OFF = 0;
1830
1831 /**
Zhijun He66d065a2014-01-16 18:18:50 -08001832 * <p>If the flash is available and charged, fire flash
Zhijun He89492252014-05-23 13:49:59 -07001833 * for this capture.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001834 * @see CaptureRequest#FLASH_MODE
1835 */
1836 public static final int FLASH_MODE_SINGLE = 1;
1837
1838 /**
Zhijun He66d065a2014-01-16 18:18:50 -08001839 * <p>Transition flash to continuously on.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001840 * @see CaptureRequest#FLASH_MODE
1841 */
1842 public static final int FLASH_MODE_TORCH = 2;
1843
1844 //
Ruben Brunkeba1b3a2014-02-07 18:23:50 -08001845 // Enumeration values for CaptureRequest#HOT_PIXEL_MODE
1846 //
1847
1848 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001849 * <p>No hot pixel correction is applied.</p>
Ruben Brunkeba1b3a2014-02-07 18:23:50 -08001850 * <p>The frame rate must not be reduced relative to sensor raw output
1851 * for this option.</p>
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001852 * <p>The hotpixel map may be returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}.</p>
Ruben Brunk9d454fd2014-03-04 14:11:52 -08001853 *
1854 * @see CaptureResult#STATISTICS_HOT_PIXEL_MAP
Ruben Brunkeba1b3a2014-02-07 18:23:50 -08001855 * @see CaptureRequest#HOT_PIXEL_MODE
1856 */
1857 public static final int HOT_PIXEL_MODE_OFF = 0;
1858
1859 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001860 * <p>Hot pixel correction is applied, without reducing frame
1861 * rate relative to sensor raw output.</p>
1862 * <p>The hotpixel map may be returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}.</p>
Ruben Brunk9d454fd2014-03-04 14:11:52 -08001863 *
1864 * @see CaptureResult#STATISTICS_HOT_PIXEL_MAP
Ruben Brunkeba1b3a2014-02-07 18:23:50 -08001865 * @see CaptureRequest#HOT_PIXEL_MODE
1866 */
1867 public static final int HOT_PIXEL_MODE_FAST = 1;
1868
1869 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001870 * <p>High-quality hot pixel correction is applied, at a cost
Yin-Chia Yehfba08dd2015-04-02 14:05:14 -07001871 * of possibly reduced frame rate relative to sensor raw output.</p>
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001872 * <p>The hotpixel map may be returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}.</p>
Ruben Brunk9d454fd2014-03-04 14:11:52 -08001873 *
1874 * @see CaptureResult#STATISTICS_HOT_PIXEL_MAP
Ruben Brunkeba1b3a2014-02-07 18:23:50 -08001875 * @see CaptureRequest#HOT_PIXEL_MODE
1876 */
1877 public static final int HOT_PIXEL_MODE_HIGH_QUALITY = 2;
1878
1879 //
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001880 // Enumeration values for CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE
1881 //
1882
1883 /**
Ruben Brunk00849b32014-01-17 18:30:23 -08001884 * <p>Optical stabilization is unavailable.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001885 * @see CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE
1886 */
1887 public static final int LENS_OPTICAL_STABILIZATION_MODE_OFF = 0;
1888
1889 /**
Ruben Brunk00849b32014-01-17 18:30:23 -08001890 * <p>Optical stabilization is enabled.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001891 * @see CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE
1892 */
1893 public static final int LENS_OPTICAL_STABILIZATION_MODE_ON = 1;
1894
1895 //
1896 // Enumeration values for CaptureRequest#NOISE_REDUCTION_MODE
1897 //
1898
1899 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001900 * <p>No noise reduction is applied.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001901 * @see CaptureRequest#NOISE_REDUCTION_MODE
1902 */
1903 public static final int NOISE_REDUCTION_MODE_OFF = 0;
1904
1905 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001906 * <p>Noise reduction is applied without reducing frame rate relative to sensor
1907 * output.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001908 * @see CaptureRequest#NOISE_REDUCTION_MODE
1909 */
1910 public static final int NOISE_REDUCTION_MODE_FAST = 1;
1911
1912 /**
Yin-Chia Yehfba08dd2015-04-02 14:05:14 -07001913 * <p>High-quality noise reduction is applied, at the cost of possibly reduced frame
1914 * rate relative to sensor output.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001915 * @see CaptureRequest#NOISE_REDUCTION_MODE
1916 */
1917 public static final int NOISE_REDUCTION_MODE_HIGH_QUALITY = 2;
1918
Zhijun He0e99c222015-01-29 15:26:05 -08001919 /**
1920 * <p>MINIMAL noise reduction is applied without reducing frame rate relative to
1921 * sensor output. </p>
1922 * @see CaptureRequest#NOISE_REDUCTION_MODE
1923 */
1924 public static final int NOISE_REDUCTION_MODE_MINIMAL = 3;
1925
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07001926 //
Igor Murashkinc127f052014-01-17 18:06:02 -08001927 // Enumeration values for CaptureRequest#SENSOR_TEST_PATTERN_MODE
1928 //
1929
1930 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001931 * <p>No test pattern mode is used, and the camera
Igor Murashkinc127f052014-01-17 18:06:02 -08001932 * device returns captures from the image sensor.</p>
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07001933 * <p>This is the default if the key is not set.</p>
Igor Murashkinc127f052014-01-17 18:06:02 -08001934 * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE
1935 */
1936 public static final int SENSOR_TEST_PATTERN_MODE_OFF = 0;
1937
1938 /**
1939 * <p>Each pixel in <code>[R, G_even, G_odd, B]</code> is replaced by its
1940 * respective color channel provided in
1941 * {@link CaptureRequest#SENSOR_TEST_PATTERN_DATA android.sensor.testPatternData}.</p>
1942 * <p>For example:</p>
1943 * <pre><code>android.testPatternData = [0, 0xFFFFFFFF, 0xFFFFFFFF, 0]
1944 * </code></pre>
1945 * <p>All green pixels are 100% green. All red/blue pixels are black.</p>
1946 * <pre><code>android.testPatternData = [0xFFFFFFFF, 0, 0xFFFFFFFF, 0]
1947 * </code></pre>
1948 * <p>All red pixels are 100% red. Only the odd green pixels
1949 * are 100% green. All blue pixels are 100% black.</p>
1950 *
1951 * @see CaptureRequest#SENSOR_TEST_PATTERN_DATA
1952 * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE
1953 */
1954 public static final int SENSOR_TEST_PATTERN_MODE_SOLID_COLOR = 1;
1955
1956 /**
1957 * <p>All pixel data is replaced with an 8-bar color pattern.</p>
1958 * <p>The vertical bars (left-to-right) are as follows:</p>
1959 * <ul>
1960 * <li>100% white</li>
1961 * <li>yellow</li>
1962 * <li>cyan</li>
1963 * <li>green</li>
1964 * <li>magenta</li>
1965 * <li>red</li>
1966 * <li>blue</li>
1967 * <li>black</li>
1968 * </ul>
1969 * <p>In general the image would look like the following:</p>
1970 * <pre><code>W Y C G M R B K
1971 * W Y C G M R B K
1972 * W Y C G M R B K
1973 * W Y C G M R B K
1974 * W Y C G M R B K
1975 * . . . . . . . .
1976 * . . . . . . . .
1977 * . . . . . . . .
1978 *
1979 * (B = Blue, K = Black)
1980 * </code></pre>
1981 * <p>Each bar should take up 1/8 of the sensor pixel array width.
1982 * When this is not possible, the bar size should be rounded
1983 * down to the nearest integer and the pattern can repeat
1984 * on the right side.</p>
1985 * <p>Each bar's height must always take up the full sensor
1986 * pixel array height.</p>
1987 * <p>Each pixel in this test pattern must be set to either
1988 * 0% intensity or 100% intensity.</p>
1989 * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE
1990 */
1991 public static final int SENSOR_TEST_PATTERN_MODE_COLOR_BARS = 2;
1992
1993 /**
1994 * <p>The test pattern is similar to COLOR_BARS, except that
1995 * each bar should start at its specified color at the top,
1996 * and fade to gray at the bottom.</p>
1997 * <p>Furthermore each bar is further subdivided into a left and
1998 * right half. The left half should have a smooth gradient,
1999 * and the right half should have a quantized gradient.</p>
2000 * <p>In particular, the right half's should consist of blocks of the
2001 * same color for 1/16th active sensor pixel array width.</p>
2002 * <p>The least significant bits in the quantized gradient should
2003 * be copied from the most significant bits of the smooth gradient.</p>
2004 * <p>The height of each bar should always be a multiple of 128.
2005 * When this is not the case, the pattern should repeat at the bottom
2006 * of the image.</p>
2007 * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE
2008 */
2009 public static final int SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY = 3;
2010
2011 /**
2012 * <p>All pixel data is replaced by a pseudo-random sequence
2013 * generated from a PN9 512-bit sequence (typically implemented
2014 * in hardware with a linear feedback shift register).</p>
2015 * <p>The generator should be reset at the beginning of each frame,
2016 * and thus each subsequent raw frame with this test pattern should
2017 * be exactly the same as the last.</p>
2018 * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE
2019 */
2020 public static final int SENSOR_TEST_PATTERN_MODE_PN9 = 4;
2021
2022 /**
2023 * <p>The first custom test pattern. All custom patterns that are
2024 * available only on this camera device are at least this numeric
2025 * value.</p>
2026 * <p>All of the custom test patterns will be static
2027 * (that is the raw image must not vary from frame to frame).</p>
2028 * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE
2029 */
2030 public static final int SENSOR_TEST_PATTERN_MODE_CUSTOM1 = 256;
2031
2032 //
Zhijun Heba93fe62014-01-17 16:43:05 -08002033 // Enumeration values for CaptureRequest#SHADING_MODE
2034 //
2035
2036 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002037 * <p>No lens shading correction is applied.</p>
Zhijun Heba93fe62014-01-17 16:43:05 -08002038 * @see CaptureRequest#SHADING_MODE
Zhijun Heba93fe62014-01-17 16:43:05 -08002039 */
2040 public static final int SHADING_MODE_OFF = 0;
2041
2042 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002043 * <p>Apply lens shading corrections, without slowing
2044 * frame rate relative to sensor raw output</p>
Zhijun Heba93fe62014-01-17 16:43:05 -08002045 * @see CaptureRequest#SHADING_MODE
Zhijun Heba93fe62014-01-17 16:43:05 -08002046 */
2047 public static final int SHADING_MODE_FAST = 1;
2048
2049 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002050 * <p>Apply high-quality lens shading correction, at the
Yin-Chia Yehfba08dd2015-04-02 14:05:14 -07002051 * cost of possibly reduced frame rate.</p>
Zhijun Heba93fe62014-01-17 16:43:05 -08002052 * @see CaptureRequest#SHADING_MODE
Zhijun Heba93fe62014-01-17 16:43:05 -08002053 */
2054 public static final int SHADING_MODE_HIGH_QUALITY = 2;
2055
2056 //
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002057 // Enumeration values for CaptureRequest#STATISTICS_FACE_DETECT_MODE
2058 //
2059
2060 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002061 * <p>Do not include face detection statistics in capture
2062 * results.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002063 * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE
2064 */
2065 public static final int STATISTICS_FACE_DETECT_MODE_OFF = 0;
2066
2067 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002068 * <p>Return face rectangle and confidence values only.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002069 * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE
2070 */
2071 public static final int STATISTICS_FACE_DETECT_MODE_SIMPLE = 1;
2072
2073 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002074 * <p>Return all face
2075 * metadata.</p>
Eino-Ville Talvalafd3e2892014-10-06 10:23:55 -07002076 * <p>In this mode, face rectangles, scores, landmarks, and face IDs are all valid.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002077 * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE
2078 */
2079 public static final int STATISTICS_FACE_DETECT_MODE_FULL = 2;
2080
2081 //
Eino-Ville Talvalad96748b2013-09-12 11:11:27 -07002082 // Enumeration values for CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE
2083 //
2084
2085 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002086 * <p>Do not include a lens shading map in the capture result.</p>
Eino-Ville Talvalad96748b2013-09-12 11:11:27 -07002087 * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE
2088 */
2089 public static final int STATISTICS_LENS_SHADING_MAP_MODE_OFF = 0;
2090
2091 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002092 * <p>Include a lens shading map in the capture result.</p>
Eino-Ville Talvalad96748b2013-09-12 11:11:27 -07002093 * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE
2094 */
2095 public static final int STATISTICS_LENS_SHADING_MAP_MODE_ON = 1;
2096
2097 //
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002098 // Enumeration values for CaptureRequest#TONEMAP_MODE
2099 //
2100
2101 /**
Igor Murashkinace5bf02013-12-10 17:36:40 -08002102 * <p>Use the tone mapping curve specified in
Yin-Chia Yeh8490ace2014-05-27 10:04:54 -07002103 * the {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}* entries.</p>
Igor Murashkine0060932014-01-17 17:24:11 -08002104 * <p>All color enhancement and tonemapping must be disabled, except
2105 * for applying the tonemapping curve specified by
Yin-Chia Yeh8490ace2014-05-27 10:04:54 -07002106 * {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}.</p>
Igor Murashkine0060932014-01-17 17:24:11 -08002107 * <p>Must not slow down frame rate relative to raw
2108 * sensor output.</p>
2109 *
Yin-Chia Yeh8490ace2014-05-27 10:04:54 -07002110 * @see CaptureRequest#TONEMAP_CURVE
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002111 * @see CaptureRequest#TONEMAP_MODE
2112 */
2113 public static final int TONEMAP_MODE_CONTRAST_CURVE = 0;
2114
2115 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002116 * <p>Advanced gamma mapping and color enhancement may be applied, without
2117 * reducing frame rate compared to raw sensor output.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002118 * @see CaptureRequest#TONEMAP_MODE
2119 */
2120 public static final int TONEMAP_MODE_FAST = 1;
2121
2122 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002123 * <p>High-quality gamma mapping and color enhancement will be applied, at
Yin-Chia Yehfba08dd2015-04-02 14:05:14 -07002124 * the cost of possibly reduced frame rate compared to raw sensor output.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002125 * @see CaptureRequest#TONEMAP_MODE
2126 */
2127 public static final int TONEMAP_MODE_HIGH_QUALITY = 2;
2128
Yin-Chia Yeh956c52b2015-02-06 11:23:25 -08002129 /**
Yin-Chia Yehdc0ba092015-02-20 15:52:06 -08002130 * <p>Use the gamma value specified in android.tonemap.gamma to peform
Yin-Chia Yeh956c52b2015-02-06 11:23:25 -08002131 * tonemapping.</p>
2132 * <p>All color enhancement and tonemapping must be disabled, except
Yin-Chia Yehdc0ba092015-02-20 15:52:06 -08002133 * for applying the tonemapping curve specified by android.tonemap.gamma.</p>
Yin-Chia Yeh956c52b2015-02-06 11:23:25 -08002134 * <p>Must not slow down frame rate relative to raw sensor output.</p>
Yin-Chia Yeh956c52b2015-02-06 11:23:25 -08002135 * @see CaptureRequest#TONEMAP_MODE
2136 */
2137 public static final int TONEMAP_MODE_GAMMA_VALUE = 3;
2138
2139 /**
2140 * <p>Use the preset tonemapping curve specified in
Yin-Chia Yehdc0ba092015-02-20 15:52:06 -08002141 * android.tonemap.presetCurve to peform tonemapping.</p>
Yin-Chia Yeh956c52b2015-02-06 11:23:25 -08002142 * <p>All color enhancement and tonemapping must be disabled, except
2143 * for applying the tonemapping curve specified by
Yin-Chia Yehdc0ba092015-02-20 15:52:06 -08002144 * android.tonemap.presetCurve.</p>
Yin-Chia Yeh956c52b2015-02-06 11:23:25 -08002145 * <p>Must not slow down frame rate relative to raw sensor output.</p>
Yin-Chia Yeh956c52b2015-02-06 11:23:25 -08002146 * @see CaptureRequest#TONEMAP_MODE
2147 */
2148 public static final int TONEMAP_MODE_PRESET_CURVE = 4;
2149
2150 //
2151 // Enumeration values for CaptureRequest#TONEMAP_PRESET_CURVE
2152 //
2153
2154 /**
2155 * <p>Tonemapping curve is defined by sRGB</p>
2156 * @see CaptureRequest#TONEMAP_PRESET_CURVE
2157 */
2158 public static final int TONEMAP_PRESET_CURVE_SRGB = 0;
2159
2160 /**
2161 * <p>Tonemapping curve is defined by ITU-R BT.709</p>
2162 * @see CaptureRequest#TONEMAP_PRESET_CURVE
2163 */
2164 public static final int TONEMAP_PRESET_CURVE_REC709 = 1;
2165
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002166 //
2167 // Enumeration values for CaptureResult#CONTROL_AE_STATE
2168 //
2169
2170 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002171 * <p>AE is off or recently reset.</p>
2172 * <p>When a camera device is opened, it starts in
Zhijun He60b19dc2014-02-24 10:19:20 -08002173 * this state. This is a transient state, the camera device may skip reporting
2174 * this state in capture result.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002175 * @see CaptureResult#CONTROL_AE_STATE
2176 */
2177 public static final int CONTROL_AE_STATE_INACTIVE = 0;
2178
2179 /**
Igor Murashkinace5bf02013-12-10 17:36:40 -08002180 * <p>AE doesn't yet have a good set of control values
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002181 * for the current scene.</p>
2182 * <p>This is a transient state, the camera device may skip
Zhijun He60b19dc2014-02-24 10:19:20 -08002183 * reporting this state in capture result.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002184 * @see CaptureResult#CONTROL_AE_STATE
2185 */
2186 public static final int CONTROL_AE_STATE_SEARCHING = 1;
2187
2188 /**
Igor Murashkinace5bf02013-12-10 17:36:40 -08002189 * <p>AE has a good set of control values for the
Zhijun He228f4f92014-01-16 17:22:05 -08002190 * current scene.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002191 * @see CaptureResult#CONTROL_AE_STATE
2192 */
2193 public static final int CONTROL_AE_STATE_CONVERGED = 2;
2194
2195 /**
Zhijun He228f4f92014-01-16 17:22:05 -08002196 * <p>AE has been locked.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002197 * @see CaptureResult#CONTROL_AE_STATE
2198 */
2199 public static final int CONTROL_AE_STATE_LOCKED = 3;
2200
2201 /**
Igor Murashkinace5bf02013-12-10 17:36:40 -08002202 * <p>AE has a good set of control values, but flash
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002203 * needs to be fired for good quality still
Zhijun He228f4f92014-01-16 17:22:05 -08002204 * capture.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002205 * @see CaptureResult#CONTROL_AE_STATE
2206 */
2207 public static final int CONTROL_AE_STATE_FLASH_REQUIRED = 4;
2208
2209 /**
Igor Murashkinace5bf02013-12-10 17:36:40 -08002210 * <p>AE has been asked to do a precapture sequence
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002211 * and is currently executing it.</p>
2212 * <p>Precapture can be triggered through setting
Zhijun Hefa95b042015-02-09 10:40:49 -08002213 * {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} to START. Currently
2214 * active and completed (if it causes camera device internal AE lock) precapture
2215 * metering sequence can be canceled through setting
2216 * {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} to CANCEL.</p>
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002217 * <p>Once PRECAPTURE completes, AE will transition to CONVERGED
2218 * or FLASH_REQUIRED as appropriate. This is a transient
2219 * state, the camera device may skip reporting this state in
2220 * capture result.</p>
Zhijun He228f4f92014-01-16 17:22:05 -08002221 *
2222 * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002223 * @see CaptureResult#CONTROL_AE_STATE
2224 */
2225 public static final int CONTROL_AE_STATE_PRECAPTURE = 5;
2226
2227 //
2228 // Enumeration values for CaptureResult#CONTROL_AF_STATE
2229 //
2230
2231 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002232 * <p>AF is off or has not yet tried to scan/been asked
2233 * to scan.</p>
2234 * <p>When a camera device is opened, it starts in this
2235 * state. This is a transient state, the camera device may
2236 * skip reporting this state in capture
2237 * result.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002238 * @see CaptureResult#CONTROL_AF_STATE
2239 */
2240 public static final int CONTROL_AF_STATE_INACTIVE = 0;
2241
2242 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002243 * <p>AF is currently performing an AF scan initiated the
2244 * camera device in a continuous autofocus mode.</p>
2245 * <p>Only used by CONTINUOUS_* AF modes. This is a transient
2246 * state, the camera device may skip reporting this state in
2247 * capture result.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002248 * @see CaptureResult#CONTROL_AF_STATE
2249 */
2250 public static final int CONTROL_AF_STATE_PASSIVE_SCAN = 1;
2251
2252 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002253 * <p>AF currently believes it is in focus, but may
2254 * restart scanning at any time.</p>
2255 * <p>Only used by CONTINUOUS_* AF modes. This is a transient
2256 * state, the camera device may skip reporting this state in
2257 * capture result.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002258 * @see CaptureResult#CONTROL_AF_STATE
2259 */
2260 public static final int CONTROL_AF_STATE_PASSIVE_FOCUSED = 2;
2261
2262 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002263 * <p>AF is performing an AF scan because it was
2264 * triggered by AF trigger.</p>
2265 * <p>Only used by AUTO or MACRO AF modes. This is a transient
2266 * state, the camera device may skip reporting this state in
2267 * capture result.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002268 * @see CaptureResult#CONTROL_AF_STATE
2269 */
2270 public static final int CONTROL_AF_STATE_ACTIVE_SCAN = 3;
2271
2272 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002273 * <p>AF believes it is focused correctly and has locked
2274 * focus.</p>
2275 * <p>This state is reached only after an explicit START AF trigger has been
2276 * sent ({@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}), when good focus has been obtained.</p>
2277 * <p>The lens will remain stationary until the AF mode ({@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}) is changed or
2278 * a new AF trigger is sent to the camera device ({@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}).</p>
2279 *
2280 * @see CaptureRequest#CONTROL_AF_MODE
2281 * @see CaptureRequest#CONTROL_AF_TRIGGER
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002282 * @see CaptureResult#CONTROL_AF_STATE
2283 */
2284 public static final int CONTROL_AF_STATE_FOCUSED_LOCKED = 4;
2285
2286 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002287 * <p>AF has failed to focus successfully and has locked
2288 * focus.</p>
2289 * <p>This state is reached only after an explicit START AF trigger has been
2290 * sent ({@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}), when good focus cannot be obtained.</p>
2291 * <p>The lens will remain stationary until the AF mode ({@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}) is changed or
2292 * a new AF trigger is sent to the camera device ({@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}).</p>
2293 *
2294 * @see CaptureRequest#CONTROL_AF_MODE
2295 * @see CaptureRequest#CONTROL_AF_TRIGGER
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002296 * @see CaptureResult#CONTROL_AF_STATE
2297 */
2298 public static final int CONTROL_AF_STATE_NOT_FOCUSED_LOCKED = 5;
2299
Eino-Ville Talvala9f880f72013-09-20 17:50:41 -07002300 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002301 * <p>AF finished a passive scan without finding focus,
2302 * and may restart scanning at any time.</p>
2303 * <p>Only used by CONTINUOUS_* AF modes. This is a transient state, the camera
Zhijun He60b19dc2014-02-24 10:19:20 -08002304 * device may skip reporting this state in capture result.</p>
Igor Murashkin4b8cd6b2014-10-02 16:00:52 -07002305 * <p>LEGACY camera devices do not support this state. When a passive
2306 * scan has finished, it will always go to PASSIVE_FOCUSED.</p>
Eino-Ville Talvala9f880f72013-09-20 17:50:41 -07002307 * @see CaptureResult#CONTROL_AF_STATE
2308 */
2309 public static final int CONTROL_AF_STATE_PASSIVE_UNFOCUSED = 6;
2310
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002311 //
2312 // Enumeration values for CaptureResult#CONTROL_AWB_STATE
2313 //
2314
2315 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002316 * <p>AWB is not in auto mode, or has not yet started metering.</p>
2317 * <p>When a camera device is opened, it starts in this
2318 * state. This is a transient state, the camera device may
2319 * skip reporting this state in capture
2320 * result.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002321 * @see CaptureResult#CONTROL_AWB_STATE
2322 */
2323 public static final int CONTROL_AWB_STATE_INACTIVE = 0;
2324
2325 /**
Igor Murashkinace5bf02013-12-10 17:36:40 -08002326 * <p>AWB doesn't yet have a good set of control
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002327 * values for the current scene.</p>
2328 * <p>This is a transient state, the camera device
Zhijun He60b19dc2014-02-24 10:19:20 -08002329 * may skip reporting this state in capture result.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002330 * @see CaptureResult#CONTROL_AWB_STATE
2331 */
2332 public static final int CONTROL_AWB_STATE_SEARCHING = 1;
2333
2334 /**
Igor Murashkinace5bf02013-12-10 17:36:40 -08002335 * <p>AWB has a good set of control values for the
Zhijun He228f4f92014-01-16 17:22:05 -08002336 * current scene.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002337 * @see CaptureResult#CONTROL_AWB_STATE
2338 */
2339 public static final int CONTROL_AWB_STATE_CONVERGED = 2;
2340
2341 /**
Zhijun He228f4f92014-01-16 17:22:05 -08002342 * <p>AWB has been locked.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002343 * @see CaptureResult#CONTROL_AWB_STATE
2344 */
2345 public static final int CONTROL_AWB_STATE_LOCKED = 3;
2346
2347 //
2348 // Enumeration values for CaptureResult#FLASH_STATE
2349 //
2350
2351 /**
Zhijun He8dda7272014-03-25 13:49:30 -07002352 * <p>No flash on camera.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002353 * @see CaptureResult#FLASH_STATE
2354 */
2355 public static final int FLASH_STATE_UNAVAILABLE = 0;
2356
2357 /**
Zhijun He8dda7272014-03-25 13:49:30 -07002358 * <p>Flash is charging and cannot be fired.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002359 * @see CaptureResult#FLASH_STATE
2360 */
2361 public static final int FLASH_STATE_CHARGING = 1;
2362
2363 /**
Zhijun He8dda7272014-03-25 13:49:30 -07002364 * <p>Flash is ready to fire.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002365 * @see CaptureResult#FLASH_STATE
2366 */
2367 public static final int FLASH_STATE_READY = 2;
2368
2369 /**
Zhijun He8dda7272014-03-25 13:49:30 -07002370 * <p>Flash fired for this capture.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002371 * @see CaptureResult#FLASH_STATE
2372 */
2373 public static final int FLASH_STATE_FIRED = 3;
2374
Zhijun He8dda7272014-03-25 13:49:30 -07002375 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002376 * <p>Flash partially illuminated this frame.</p>
2377 * <p>This is usually due to the next or previous frame having
2378 * the flash fire, and the flash spilling into this capture
Zhijun He8dda7272014-03-25 13:49:30 -07002379 * due to hardware limitations.</p>
2380 * @see CaptureResult#FLASH_STATE
2381 */
2382 public static final int FLASH_STATE_PARTIAL = 4;
2383
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002384 //
2385 // Enumeration values for CaptureResult#LENS_STATE
2386 //
2387
2388 /**
Eino-Ville Talvalad8fd6792014-02-10 12:41:04 -08002389 * <p>The lens parameters ({@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance},
2390 * {@link CaptureRequest#LENS_FILTER_DENSITY android.lens.filterDensity} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}) are not changing.</p>
Zhijun Heca1b73a2014-02-03 12:39:53 -08002391 *
2392 * @see CaptureRequest#LENS_APERTURE
Eino-Ville Talvalad8fd6792014-02-10 12:41:04 -08002393 * @see CaptureRequest#LENS_FILTER_DENSITY
Zhijun Heca1b73a2014-02-03 12:39:53 -08002394 * @see CaptureRequest#LENS_FOCAL_LENGTH
Eino-Ville Talvalad8fd6792014-02-10 12:41:04 -08002395 * @see CaptureRequest#LENS_FOCUS_DISTANCE
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002396 * @see CaptureResult#LENS_STATE
2397 */
2398 public static final int LENS_STATE_STATIONARY = 0;
2399
Igor Murashkin9ea4ae62013-09-11 21:40:11 -07002400 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002401 * <p>One or several of the lens parameters
2402 * ({@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance},
2403 * {@link CaptureRequest#LENS_FILTER_DENSITY android.lens.filterDensity} or {@link CaptureRequest#LENS_APERTURE android.lens.aperture}) is
2404 * currently changing.</p>
Zhijun Heca1b73a2014-02-03 12:39:53 -08002405 *
2406 * @see CaptureRequest#LENS_APERTURE
Eino-Ville Talvalad8fd6792014-02-10 12:41:04 -08002407 * @see CaptureRequest#LENS_FILTER_DENSITY
Zhijun Heca1b73a2014-02-03 12:39:53 -08002408 * @see CaptureRequest#LENS_FOCAL_LENGTH
Eino-Ville Talvalad8fd6792014-02-10 12:41:04 -08002409 * @see CaptureRequest#LENS_FOCUS_DISTANCE
Igor Murashkin9ea4ae62013-09-11 21:40:11 -07002410 * @see CaptureResult#LENS_STATE
2411 */
2412 public static final int LENS_STATE_MOVING = 1;
2413
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002414 //
2415 // Enumeration values for CaptureResult#STATISTICS_SCENE_FLICKER
2416 //
2417
2418 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002419 * <p>The camera device does not detect any flickering illumination
2420 * in the current scene.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002421 * @see CaptureResult#STATISTICS_SCENE_FLICKER
2422 */
2423 public static final int STATISTICS_SCENE_FLICKER_NONE = 0;
2424
2425 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002426 * <p>The camera device detects illumination flickering at 50Hz
2427 * in the current scene.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002428 * @see CaptureResult#STATISTICS_SCENE_FLICKER
2429 */
2430 public static final int STATISTICS_SCENE_FLICKER_50HZ = 1;
2431
2432 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002433 * <p>The camera device detects illumination flickering at 60Hz
2434 * in the current scene.</p>
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002435 * @see CaptureResult#STATISTICS_SCENE_FLICKER
2436 */
2437 public static final int STATISTICS_SCENE_FLICKER_60HZ = 2;
2438
Igor Murashkin3865a842014-01-17 18:18:39 -08002439 //
2440 // Enumeration values for CaptureResult#SYNC_FRAME_NUMBER
2441 //
2442
2443 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002444 * <p>The current result is not yet fully synchronized to any request.</p>
2445 * <p>Synchronization is in progress, and reading metadata from this
Igor Murashkin3865a842014-01-17 18:18:39 -08002446 * result may include a mix of data that have taken effect since the
2447 * last synchronization time.</p>
2448 * <p>In some future result, within {@link CameraCharacteristics#SYNC_MAX_LATENCY android.sync.maxLatency} frames,
2449 * this value will update to the actual frame number frame number
2450 * the result is guaranteed to be synchronized to (as long as the
2451 * request settings remain constant).</p>
2452 *
2453 * @see CameraCharacteristics#SYNC_MAX_LATENCY
2454 * @see CaptureResult#SYNC_FRAME_NUMBER
2455 * @hide
2456 */
2457 public static final int SYNC_FRAME_NUMBER_CONVERGING = -1;
2458
2459 /**
Eino-Ville Talvalae600d6a2014-06-09 14:25:50 -07002460 * <p>The current result's synchronization status is unknown.</p>
2461 * <p>The result may have already converged, or it may be in
2462 * progress. Reading from this result may include some mix
2463 * of settings from past requests.</p>
Igor Murashkin3865a842014-01-17 18:18:39 -08002464 * <p>After a settings change, the new settings will eventually all
2465 * take effect for the output buffers and results. However, this
2466 * value will not change when that happens. Altering settings
2467 * rapidly may provide outcomes using mixes of settings from recent
2468 * requests.</p>
2469 * <p>This value is intended primarily for backwards compatibility with
2470 * the older camera implementations (for android.hardware.Camera).</p>
2471 * @see CaptureResult#SYNC_FRAME_NUMBER
2472 * @hide
2473 */
2474 public static final int SYNC_FRAME_NUMBER_UNKNOWN = -2;
2475
Eino-Ville Talvala5a32b20c2013-08-08 12:38:36 -07002476 /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~
2477 * End generated code
2478 *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/
2479
Igor Murashkinb519cc52013-07-02 11:23:44 -07002480}