CameraMetadata.java revision 126a7468c2b86f27779443f5f2578a03f3ad78e8
1/*
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
17package android.hardware.camera2;
18
19import android.hardware.camera2.impl.CameraMetadataNative;
20import android.hardware.camera2.impl.PublicKey;
21import android.hardware.camera2.impl.SyntheticKey;
22import android.util.Log;
23
24import java.lang.reflect.Field;
25import java.lang.reflect.Modifier;
26import java.util.ArrayList;
27import java.util.Arrays;
28import java.util.Collections;
29import java.util.List;
30
31/**
32 * The base class for camera controls and information.
33 *
34 * <p>
35 * 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.
38 * </p>
39 *
40 * <p>
41 * All instances of CameraMetadata are immutable. The list of keys with {@link #getKeys()}
42 * never changes, nor do the values returned by any key with {@code #get} throughout
43 * the lifetime of the object.
44 * </p>
45 *
46 * @see CameraDevice
47 * @see CameraManager
48 * @see CameraCharacteristics
49 **/
50public abstract class CameraMetadata<TKey> {
51
52    private static final String TAG = "CameraMetadataAb";
53    private static final boolean VERBOSE = Log.isLoggable(TAG, Log.VERBOSE);
54
55    /**
56     * 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     *
64     * @hide
65     */
66    protected CameraMetadata() {
67    }
68
69    /**
70     * Get a camera metadata field value.
71     *
72     * <p>The field definitions can be
73     * found in {@link CameraCharacteristics}, {@link CaptureResult}, and
74     * {@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>
78     *
79     * @throws IllegalArgumentException if the key was not valid
80     *
81     * @param key The metadata field to read.
82     * @return The value of that key, or {@code null} if the field is not set.
83     *
84     * @hide
85     */
86     protected abstract <T> T getProtected(TKey key);
87
88     /**
89      * @hide
90      */
91     protected abstract Class<TKey> getKeyClass();
92
93    /**
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     *
99     * <p>All values retrieved by a key from this list with {@code #get} are guaranteed to be
100     * 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     */
105    @SuppressWarnings("unchecked")
106    public List<TKey> getKeys() {
107        Class<CameraMetadata<TKey>> thisClass = (Class<CameraMetadata<TKey>>) getClass();
108        return Collections.unmodifiableList(
109                getKeysStatic(thisClass, getKeyClass(), this, /*filterTags*/null));
110    }
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>
119     *
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>
125     */
126     /*package*/ @SuppressWarnings("unchecked")
127    static <TKey> ArrayList<TKey> getKeysStatic(
128             Class<?> type, Class<TKey> keyClass,
129             CameraMetadata<TKey> instance,
130             int[] filterTags) {
131
132        if (VERBOSE) Log.v(TAG, "getKeysStatic for " + type);
133
134        // 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
139        if (filterTags != null) {
140            Arrays.sort(filterTags);
141        }
142
143        ArrayList<TKey> keyList = new ArrayList<TKey>();
144
145        Field[] fields = type.getDeclaredFields();
146        for (Field field : fields) {
147            // Filter for Keys that are public
148            if (field.getType().isAssignableFrom(keyClass) &&
149                    (field.getModifiers() & Modifier.PUBLIC) != 0) {
150
151                TKey key;
152                try {
153                    key = (TKey) field.get(instance);
154                } 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                }
159
160                if (instance == null || instance.getProtected(key) != null) {
161                    if (shouldKeyBeAdded(key, field, filterTags)) {
162                        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                    }
170                }
171            }
172        }
173
174        return keyList;
175    }
176
177    @SuppressWarnings("rawtypes")
178    private static <TKey> boolean shouldKeyBeAdded(TKey key, Field field, int[] filterTags) {
179        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
199        if (field.getAnnotation(PublicKey.class) == null) {
200            // Never expose @hide keys up to the API user
201            return false;
202        }
203
204        // No filtering necessary
205        if (filterTags == null) {
206            return true;
207        }
208
209        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
220        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
226    /*@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    //
233    // 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
238     * {@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
240     * 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    /**
253     * <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>
259     * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION
260     */
261    public static final int LENS_INFO_FOCUS_DISTANCE_CALIBRATION_APPROXIMATE = 1;
262
263    /**
264     * <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>
271     * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION
272     */
273    public static final int LENS_INFO_FOCUS_DISTANCE_CALIBRATION_CALIBRATED = 2;
274
275    //
276    // Enumeration values for CameraCharacteristics#LENS_FACING
277    //
278
279    /**
280     * <p>The camera device faces the same direction as the device's screen.</p>
281     * @see CameraCharacteristics#LENS_FACING
282     */
283    public static final int LENS_FACING_FRONT = 0;
284
285    /**
286     * <p>The camera device faces the opposite direction as the device's screen.</p>
287     * @see CameraCharacteristics#LENS_FACING
288     */
289    public static final int LENS_FACING_BACK = 1;
290
291    //
292    // Enumeration values for CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
293    //
294
295    /**
296     * <p>The minimal set of capabilities that every camera
297     * device (regardless of {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel})
298     * supports.</p>
299     * <p>This capability is listed by all devices, and
300     * indicates that the camera device has a feature set
301     * that's comparable to the baseline requirements for the
302     * older android.hardware.Camera API.</p>
303     *
304     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
305     * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
306     */
307    public static final int REQUEST_AVAILABLE_CAPABILITIES_BACKWARD_COMPATIBLE = 0;
308
309    /**
310     * <p>The camera device can be manually controlled (3A algorithms such
311     * as auto-exposure, and auto-focus can be bypassed).
312     * The camera device supports basic manual control of the sensor image
313     * acquisition related stages. This means the following controls are
314     * guaranteed to be supported:</p>
315     * <ul>
316     * <li>Manual frame duration control<ul>
317     * <li>{@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration}</li>
318     * <li>{@link CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION android.sensor.info.maxFrameDuration}</li>
319     * </ul>
320     * </li>
321     * <li>Manual exposure control<ul>
322     * <li>{@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}</li>
323     * <li>{@link CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE android.sensor.info.exposureTimeRange}</li>
324     * </ul>
325     * </li>
326     * <li>Manual sensitivity control<ul>
327     * <li>{@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}</li>
328     * <li>{@link CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE android.sensor.info.sensitivityRange}</li>
329     * </ul>
330     * </li>
331     * <li>Manual lens control (if the lens is adjustable)<ul>
332     * <li>android.lens.*</li>
333     * </ul>
334     * </li>
335     * <li>Manual flash control (if a flash unit is present)<ul>
336     * <li>android.flash.*</li>
337     * </ul>
338     * </li>
339     * <li>Manual black level locking<ul>
340     * <li>{@link CaptureRequest#BLACK_LEVEL_LOCK android.blackLevel.lock}</li>
341     * </ul>
342     * </li>
343     * </ul>
344     * <p>If any of the above 3A algorithms are enabled, then the camera
345     * device will accurately report the values applied by 3A in the
346     * result.</p>
347     * <p>A given camera device may also support additional manual sensor controls,
348     * but this capability only covers the above list of controls.</p>
349     * <p>If this is supported, {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap} will
350     * additionally return a min frame duration that is greater than
351     * zero for each supported size-format combination.</p>
352     *
353     * @see CaptureRequest#BLACK_LEVEL_LOCK
354     * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP
355     * @see CaptureRequest#SENSOR_EXPOSURE_TIME
356     * @see CaptureRequest#SENSOR_FRAME_DURATION
357     * @see CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE
358     * @see CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION
359     * @see CameraCharacteristics#SENSOR_INFO_SENSITIVITY_RANGE
360     * @see CaptureRequest#SENSOR_SENSITIVITY
361     * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
362     */
363    public static final int REQUEST_AVAILABLE_CAPABILITIES_MANUAL_SENSOR = 1;
364
365    /**
366     * <p>The camera device post-processing stages can be manually controlled.
367     * The camera device supports basic manual control of the image post-processing
368     * stages. This means the following controls are guaranteed to be supported:</p>
369     * <ul>
370     * <li>Manual tonemap control<ul>
371     * <li>{@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}</li>
372     * <li>{@link CaptureRequest#TONEMAP_MODE android.tonemap.mode}</li>
373     * <li>{@link CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS android.tonemap.maxCurvePoints}</li>
374     * </ul>
375     * </li>
376     * <li>Manual white balance control<ul>
377     * <li>{@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}</li>
378     * <li>{@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains}</li>
379     * </ul>
380     * </li>
381     * <li>Manual lens shading map control<ul>
382     * <li>{@link CaptureRequest#SHADING_MODE android.shading.mode}</li>
383     * <li>{@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode}</li>
384     * <li>android.statistics.lensShadingMap</li>
385     * <li>android.lens.info.shadingMapSize</li>
386     * </ul>
387     * </li>
388     * <li>Manual aberration correction control (if aberration correction is supported)<ul>
389     * <li>{@link CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE android.colorCorrection.aberrationMode}</li>
390     * <li>{@link CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES android.colorCorrection.availableAberrationModes}</li>
391     * </ul>
392     * </li>
393     * </ul>
394     * <p>If auto white balance is enabled, then the camera device
395     * will accurately report the values applied by AWB in the result.</p>
396     * <p>A given camera device may also support additional post-processing
397     * controls, but this capability only covers the above list of controls.</p>
398     *
399     * @see CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE
400     * @see CameraCharacteristics#COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES
401     * @see CaptureRequest#COLOR_CORRECTION_GAINS
402     * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
403     * @see CaptureRequest#SHADING_MODE
404     * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE
405     * @see CaptureRequest#TONEMAP_CURVE
406     * @see CameraCharacteristics#TONEMAP_MAX_CURVE_POINTS
407     * @see CaptureRequest#TONEMAP_MODE
408     * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
409     */
410    public static final int REQUEST_AVAILABLE_CAPABILITIES_MANUAL_POST_PROCESSING = 2;
411
412    /**
413     * <p>The camera device supports outputting RAW buffers and
414     * metadata for interpreting them.</p>
415     * <p>Devices supporting the RAW capability allow both for
416     * saving DNG files, and for direct application processing of
417     * raw sensor images.</p>
418     * <ul>
419     * <li>RAW_SENSOR is supported as an output format.</li>
420     * <li>The maximum available resolution for RAW_SENSOR streams
421     *   will match either the value in
422     *   {@link CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE android.sensor.info.pixelArraySize} or
423     *   {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}.</li>
424     * <li>All DNG-related optional metadata entries are provided
425     *   by the camera device.</li>
426     * </ul>
427     *
428     * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
429     * @see CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE
430     * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
431     */
432    public static final int REQUEST_AVAILABLE_CAPABILITIES_RAW = 3;
433
434    /**
435     * <p>The camera device supports the Zero Shutter Lag use case.</p>
436     * <ul>
437     * <li>At least one input stream can be used.</li>
438     * <li>RAW_OPAQUE is supported as an output/input format</li>
439     * <li>Using RAW_OPAQUE does not cause a frame rate drop
440     *   relative to the sensor's maximum capture rate (at that
441     *   resolution).</li>
442     * <li>RAW_OPAQUE will be reprocessable into both YUV_420_888
443     *   and JPEG formats.</li>
444     * <li>The maximum available resolution for RAW_OPAQUE streams
445     *   (both input/output) will match the maximum available
446     *   resolution of JPEG streams.</li>
447     * </ul>
448     * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
449     * @hide
450     */
451    public static final int REQUEST_AVAILABLE_CAPABILITIES_ZSL = 4;
452
453    /**
454     * <p>The camera device supports accurately reporting the sensor settings for many of
455     * the sensor controls while the built-in 3A algorithm is running.  This allows
456     * reporting of sensor settings even when these settings cannot be manually changed.</p>
457     * <p>The values reported for the following controls are guaranteed to be available
458     * in the CaptureResult, including when 3A is enabled:</p>
459     * <ul>
460     * <li>Exposure control<ul>
461     * <li>{@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}</li>
462     * </ul>
463     * </li>
464     * <li>Sensitivity control<ul>
465     * <li>{@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}</li>
466     * </ul>
467     * </li>
468     * <li>Lens controls (if the lens is adjustable)<ul>
469     * <li>{@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance}</li>
470     * <li>{@link CaptureRequest#LENS_APERTURE android.lens.aperture}</li>
471     * </ul>
472     * </li>
473     * </ul>
474     * <p>This capability is a subset of the MANUAL_SENSOR control capability, and will
475     * always be included if the MANUAL_SENSOR capability is available.</p>
476     *
477     * @see CaptureRequest#LENS_APERTURE
478     * @see CaptureRequest#LENS_FOCUS_DISTANCE
479     * @see CaptureRequest#SENSOR_EXPOSURE_TIME
480     * @see CaptureRequest#SENSOR_SENSITIVITY
481     * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
482     */
483    public static final int REQUEST_AVAILABLE_CAPABILITIES_READ_SENSOR_SETTINGS = 5;
484
485    /**
486     * <p>The camera device supports capturing maximum-resolution
487     * images at &gt;= 20 frames per second, in at least the
488     * uncompressed YUV format, when post-processing settings
489     * are set to FAST.</p>
490     * <p>More specifically, this means that a size matching the
491     * camera device's active array size is listed as a
492     * supported size for the YUV_420_888 format in
493     * {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap}, and the
494     * minimum frame duration for that format and size is &lt;=
495     * 1/20 s.</p>
496     * <p>In addition, the {@link CameraCharacteristics#SYNC_MAX_LATENCY android.sync.maxLatency} field is
497     * guaranted to have a value between 0 and 4, inclusive.</p>
498     *
499     * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP
500     * @see CameraCharacteristics#SYNC_MAX_LATENCY
501     * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
502     */
503    public static final int REQUEST_AVAILABLE_CAPABILITIES_BURST_CAPTURE = 6;
504
505    //
506    // Enumeration values for CameraCharacteristics#SCALER_CROPPING_TYPE
507    //
508
509    /**
510     * <p>The camera device only supports centered crop regions.</p>
511     * @see CameraCharacteristics#SCALER_CROPPING_TYPE
512     */
513    public static final int SCALER_CROPPING_TYPE_CENTER_ONLY = 0;
514
515    /**
516     * <p>The camera device supports arbitrarily chosen crop regions.</p>
517     * @see CameraCharacteristics#SCALER_CROPPING_TYPE
518     */
519    public static final int SCALER_CROPPING_TYPE_FREEFORM = 1;
520
521    //
522    // Enumeration values for CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT
523    //
524
525    /**
526     * @see CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT
527     */
528    public static final int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGGB = 0;
529
530    /**
531     * @see CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT
532     */
533    public static final int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GRBG = 1;
534
535    /**
536     * @see CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT
537     */
538    public static final int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GBRG = 2;
539
540    /**
541     * @see CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT
542     */
543    public static final int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_BGGR = 3;
544
545    /**
546     * <p>Sensor is not Bayer; output has 3 16-bit
547     * values for each pixel, instead of just 1 16-bit value
548     * per pixel.</p>
549     * @see CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT
550     */
551    public static final int SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGB = 4;
552
553    //
554    // Enumeration values for CameraCharacteristics#SENSOR_INFO_TIMESTAMP_SOURCE
555    //
556
557    /**
558     * <p>Timestamps from {@link CaptureResult#SENSOR_TIMESTAMP android.sensor.timestamp} are in nanoseconds and monotonic,
559     * but can not be compared to timestamps from other subsystems
560     * (e.g. accelerometer, gyro etc.), or other instances of the same or different
561     * camera devices in the same system. Timestamps between streams and results for
562     * a single camera instance are comparable, and the timestamps for all buffers
563     * and the result metadata generated by a single capture are identical.</p>
564     *
565     * @see CaptureResult#SENSOR_TIMESTAMP
566     * @see CameraCharacteristics#SENSOR_INFO_TIMESTAMP_SOURCE
567     */
568    public static final int SENSOR_INFO_TIMESTAMP_SOURCE_UNKNOWN = 0;
569
570    /**
571     * <p>Timestamps from {@link CaptureResult#SENSOR_TIMESTAMP android.sensor.timestamp} are in the same timebase as
572     * android.os.SystemClock#elapsedRealtimeNanos(),
573     * and they can be compared to other timestamps using that base.</p>
574     *
575     * @see CaptureResult#SENSOR_TIMESTAMP
576     * @see CameraCharacteristics#SENSOR_INFO_TIMESTAMP_SOURCE
577     */
578    public static final int SENSOR_INFO_TIMESTAMP_SOURCE_REALTIME = 1;
579
580    //
581    // Enumeration values for CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
582    //
583
584    /**
585     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
586     */
587    public static final int SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT = 1;
588
589    /**
590     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
591     */
592    public static final int SENSOR_REFERENCE_ILLUMINANT1_FLUORESCENT = 2;
593
594    /**
595     * <p>Incandescent light</p>
596     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
597     */
598    public static final int SENSOR_REFERENCE_ILLUMINANT1_TUNGSTEN = 3;
599
600    /**
601     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
602     */
603    public static final int SENSOR_REFERENCE_ILLUMINANT1_FLASH = 4;
604
605    /**
606     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
607     */
608    public static final int SENSOR_REFERENCE_ILLUMINANT1_FINE_WEATHER = 9;
609
610    /**
611     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
612     */
613    public static final int SENSOR_REFERENCE_ILLUMINANT1_CLOUDY_WEATHER = 10;
614
615    /**
616     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
617     */
618    public static final int SENSOR_REFERENCE_ILLUMINANT1_SHADE = 11;
619
620    /**
621     * <p>D 5700 - 7100K</p>
622     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
623     */
624    public static final int SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT_FLUORESCENT = 12;
625
626    /**
627     * <p>N 4600 - 5400K</p>
628     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
629     */
630    public static final int SENSOR_REFERENCE_ILLUMINANT1_DAY_WHITE_FLUORESCENT = 13;
631
632    /**
633     * <p>W 3900 - 4500K</p>
634     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
635     */
636    public static final int SENSOR_REFERENCE_ILLUMINANT1_COOL_WHITE_FLUORESCENT = 14;
637
638    /**
639     * <p>WW 3200 - 3700K</p>
640     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
641     */
642    public static final int SENSOR_REFERENCE_ILLUMINANT1_WHITE_FLUORESCENT = 15;
643
644    /**
645     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
646     */
647    public static final int SENSOR_REFERENCE_ILLUMINANT1_STANDARD_A = 17;
648
649    /**
650     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
651     */
652    public static final int SENSOR_REFERENCE_ILLUMINANT1_STANDARD_B = 18;
653
654    /**
655     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
656     */
657    public static final int SENSOR_REFERENCE_ILLUMINANT1_STANDARD_C = 19;
658
659    /**
660     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
661     */
662    public static final int SENSOR_REFERENCE_ILLUMINANT1_D55 = 20;
663
664    /**
665     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
666     */
667    public static final int SENSOR_REFERENCE_ILLUMINANT1_D65 = 21;
668
669    /**
670     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
671     */
672    public static final int SENSOR_REFERENCE_ILLUMINANT1_D75 = 22;
673
674    /**
675     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
676     */
677    public static final int SENSOR_REFERENCE_ILLUMINANT1_D50 = 23;
678
679    /**
680     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
681     */
682    public static final int SENSOR_REFERENCE_ILLUMINANT1_ISO_STUDIO_TUNGSTEN = 24;
683
684    //
685    // Enumeration values for CameraCharacteristics#LED_AVAILABLE_LEDS
686    //
687
688    /**
689     * <p>android.led.transmit control is used.</p>
690     * @see CameraCharacteristics#LED_AVAILABLE_LEDS
691     * @hide
692     */
693    public static final int LED_AVAILABLE_LEDS_TRANSMIT = 0;
694
695    //
696    // Enumeration values for CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
697    //
698
699    /**
700     * <p>This camera device has only limited capabilities.</p>
701     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
702     */
703    public static final int INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED = 0;
704
705    /**
706     * <p>This camera device is capable of supporting advanced imaging applications.</p>
707     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
708     */
709    public static final int INFO_SUPPORTED_HARDWARE_LEVEL_FULL = 1;
710
711    /**
712     * <p>This camera device is running in backward compatibility mode.</p>
713     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
714     */
715    public static final int INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY = 2;
716
717    //
718    // Enumeration values for CameraCharacteristics#SYNC_MAX_LATENCY
719    //
720
721    /**
722     * <p>Every frame has the requests immediately applied.</p>
723     * <p>Furthermore for all results,
724     * <code>android.sync.frameNumber == CaptureResult#getFrameNumber()</code></p>
725     * <p>Changing controls over multiple requests one after another will
726     * produce results that have those controls applied atomically
727     * each frame.</p>
728     * <p>All FULL capability devices will have this as their maxLatency.</p>
729     * @see CameraCharacteristics#SYNC_MAX_LATENCY
730     */
731    public static final int SYNC_MAX_LATENCY_PER_FRAME_CONTROL = 0;
732
733    /**
734     * <p>Each new frame has some subset (potentially the entire set)
735     * of the past requests applied to the camera settings.</p>
736     * <p>By submitting a series of identical requests, the camera device
737     * will eventually have the camera settings applied, but it is
738     * unknown when that exact point will be.</p>
739     * <p>All LEGACY capability devices will have this as their maxLatency.</p>
740     * @see CameraCharacteristics#SYNC_MAX_LATENCY
741     */
742    public static final int SYNC_MAX_LATENCY_UNKNOWN = -1;
743
744    //
745    // Enumeration values for CaptureRequest#COLOR_CORRECTION_MODE
746    //
747
748    /**
749     * <p>Use the {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} matrix
750     * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} to do color conversion.</p>
751     * <p>All advanced white balance adjustments (not specified
752     * by our white balance pipeline) must be disabled.</p>
753     * <p>If AWB is enabled with <code>{@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} != OFF</code>, then
754     * TRANSFORM_MATRIX is ignored. The camera device will override
755     * this value to either FAST or HIGH_QUALITY.</p>
756     *
757     * @see CaptureRequest#COLOR_CORRECTION_GAINS
758     * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
759     * @see CaptureRequest#CONTROL_AWB_MODE
760     * @see CaptureRequest#COLOR_CORRECTION_MODE
761     */
762    public static final int COLOR_CORRECTION_MODE_TRANSFORM_MATRIX = 0;
763
764    /**
765     * <p>Color correction processing must not slow down
766     * capture rate relative to sensor raw output.</p>
767     * <p>Advanced white balance adjustments above and beyond
768     * the specified white balance pipeline may be applied.</p>
769     * <p>If AWB is enabled with <code>{@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} != OFF</code>, then
770     * the camera device uses the last frame's AWB values
771     * (or defaults if AWB has never been run).</p>
772     *
773     * @see CaptureRequest#CONTROL_AWB_MODE
774     * @see CaptureRequest#COLOR_CORRECTION_MODE
775     */
776    public static final int COLOR_CORRECTION_MODE_FAST = 1;
777
778    /**
779     * <p>Color correction processing operates at improved
780     * quality but reduced capture rate (relative to sensor raw
781     * output).</p>
782     * <p>Advanced white balance adjustments above and beyond
783     * the specified white balance pipeline may be applied.</p>
784     * <p>If AWB is enabled with <code>{@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} != OFF</code>, then
785     * the camera device uses the last frame's AWB values
786     * (or defaults if AWB has never been run).</p>
787     *
788     * @see CaptureRequest#CONTROL_AWB_MODE
789     * @see CaptureRequest#COLOR_CORRECTION_MODE
790     */
791    public static final int COLOR_CORRECTION_MODE_HIGH_QUALITY = 2;
792
793    //
794    // Enumeration values for CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE
795    //
796
797    /**
798     * <p>No aberration correction is applied.</p>
799     * @see CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE
800     */
801    public static final int COLOR_CORRECTION_ABERRATION_MODE_OFF = 0;
802
803    /**
804     * <p>Aberration correction will not slow down capture rate
805     * relative to sensor raw output.</p>
806     * @see CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE
807     */
808    public static final int COLOR_CORRECTION_ABERRATION_MODE_FAST = 1;
809
810    /**
811     * <p>Aberration correction operates at improved quality but reduced
812     * capture rate (relative to sensor raw output).</p>
813     * @see CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE
814     */
815    public static final int COLOR_CORRECTION_ABERRATION_MODE_HIGH_QUALITY = 2;
816
817    //
818    // Enumeration values for CaptureRequest#CONTROL_AE_ANTIBANDING_MODE
819    //
820
821    /**
822     * <p>The camera device will not adjust exposure duration to
823     * avoid banding problems.</p>
824     * @see CaptureRequest#CONTROL_AE_ANTIBANDING_MODE
825     */
826    public static final int CONTROL_AE_ANTIBANDING_MODE_OFF = 0;
827
828    /**
829     * <p>The camera device will adjust exposure duration to
830     * avoid banding problems with 50Hz illumination sources.</p>
831     * @see CaptureRequest#CONTROL_AE_ANTIBANDING_MODE
832     */
833    public static final int CONTROL_AE_ANTIBANDING_MODE_50HZ = 1;
834
835    /**
836     * <p>The camera device will adjust exposure duration to
837     * avoid banding problems with 60Hz illumination
838     * sources.</p>
839     * @see CaptureRequest#CONTROL_AE_ANTIBANDING_MODE
840     */
841    public static final int CONTROL_AE_ANTIBANDING_MODE_60HZ = 2;
842
843    /**
844     * <p>The camera device will automatically adapt its
845     * antibanding routine to the current illumination
846     * conditions. This is the default.</p>
847     * @see CaptureRequest#CONTROL_AE_ANTIBANDING_MODE
848     */
849    public static final int CONTROL_AE_ANTIBANDING_MODE_AUTO = 3;
850
851    //
852    // Enumeration values for CaptureRequest#CONTROL_AE_MODE
853    //
854
855    /**
856     * <p>The camera device's autoexposure routine is disabled.</p>
857     * <p>The application-selected {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime},
858     * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity} and
859     * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} are used by the camera
860     * device, along with android.flash.* fields, if there's
861     * a flash unit for this camera device.</p>
862     * <p>Note that auto-white balance (AWB) and auto-focus (AF)
863     * behavior is device dependent when AE is in OFF mode.
864     * To have consistent behavior across different devices,
865     * it is recommended to either set AWB and AF to OFF mode
866     * or lock AWB and AF before setting AE to OFF.
867     * See {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode},
868     * {@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock}, and {@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}
869     * for more details.</p>
870     * <p>LEGACY devices do not support the OFF mode and will
871     * override attempts to use this value to ON.</p>
872     *
873     * @see CaptureRequest#CONTROL_AF_MODE
874     * @see CaptureRequest#CONTROL_AF_TRIGGER
875     * @see CaptureRequest#CONTROL_AWB_LOCK
876     * @see CaptureRequest#CONTROL_AWB_MODE
877     * @see CaptureRequest#SENSOR_EXPOSURE_TIME
878     * @see CaptureRequest#SENSOR_FRAME_DURATION
879     * @see CaptureRequest#SENSOR_SENSITIVITY
880     * @see CaptureRequest#CONTROL_AE_MODE
881     */
882    public static final int CONTROL_AE_MODE_OFF = 0;
883
884    /**
885     * <p>The camera device's autoexposure routine is active,
886     * with no flash control.</p>
887     * <p>The application's values for
888     * {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime},
889     * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, and
890     * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} are ignored. The
891     * application has control over the various
892     * android.flash.* fields.</p>
893     *
894     * @see CaptureRequest#SENSOR_EXPOSURE_TIME
895     * @see CaptureRequest#SENSOR_FRAME_DURATION
896     * @see CaptureRequest#SENSOR_SENSITIVITY
897     * @see CaptureRequest#CONTROL_AE_MODE
898     */
899    public static final int CONTROL_AE_MODE_ON = 1;
900
901    /**
902     * <p>Like ON, except that the camera device also controls
903     * the camera's flash unit, firing it in low-light
904     * conditions.</p>
905     * <p>The flash may be fired during a precapture sequence
906     * (triggered by {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}) and
907     * may be fired for captures for which the
908     * {@link CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} field is set to
909     * STILL_CAPTURE</p>
910     *
911     * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
912     * @see CaptureRequest#CONTROL_CAPTURE_INTENT
913     * @see CaptureRequest#CONTROL_AE_MODE
914     */
915    public static final int CONTROL_AE_MODE_ON_AUTO_FLASH = 2;
916
917    /**
918     * <p>Like ON, except that the camera device also controls
919     * the camera's flash unit, always firing it for still
920     * captures.</p>
921     * <p>The flash may be fired during a precapture sequence
922     * (triggered by {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}) and
923     * will always be fired for captures for which the
924     * {@link CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} field is set to
925     * STILL_CAPTURE</p>
926     *
927     * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
928     * @see CaptureRequest#CONTROL_CAPTURE_INTENT
929     * @see CaptureRequest#CONTROL_AE_MODE
930     */
931    public static final int CONTROL_AE_MODE_ON_ALWAYS_FLASH = 3;
932
933    /**
934     * <p>Like ON_AUTO_FLASH, but with automatic red eye
935     * reduction.</p>
936     * <p>If deemed necessary by the camera device, a red eye
937     * reduction flash will fire during the precapture
938     * sequence.</p>
939     * @see CaptureRequest#CONTROL_AE_MODE
940     */
941    public static final int CONTROL_AE_MODE_ON_AUTO_FLASH_REDEYE = 4;
942
943    //
944    // Enumeration values for CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
945    //
946
947    /**
948     * <p>The trigger is idle.</p>
949     * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
950     */
951    public static final int CONTROL_AE_PRECAPTURE_TRIGGER_IDLE = 0;
952
953    /**
954     * <p>The precapture metering sequence will be started
955     * by the camera device.</p>
956     * <p>The exact effect of the precapture trigger depends on
957     * the current AE mode and state.</p>
958     * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
959     */
960    public static final int CONTROL_AE_PRECAPTURE_TRIGGER_START = 1;
961
962    //
963    // Enumeration values for CaptureRequest#CONTROL_AF_MODE
964    //
965
966    /**
967     * <p>The auto-focus routine does not control the lens;
968     * {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} is controlled by the
969     * application.</p>
970     *
971     * @see CaptureRequest#LENS_FOCUS_DISTANCE
972     * @see CaptureRequest#CONTROL_AF_MODE
973     */
974    public static final int CONTROL_AF_MODE_OFF = 0;
975
976    /**
977     * <p>Basic automatic focus mode.</p>
978     * <p>In this mode, the lens does not move unless
979     * the autofocus trigger action is called. When that trigger
980     * is activated, AF will transition to ACTIVE_SCAN, then to
981     * the outcome of the scan (FOCUSED or NOT_FOCUSED).</p>
982     * <p>Always supported if lens is not fixed focus.</p>
983     * <p>Use {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} to determine if lens
984     * is fixed-focus.</p>
985     * <p>Triggering AF_CANCEL resets the lens position to default,
986     * and sets the AF state to INACTIVE.</p>
987     *
988     * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE
989     * @see CaptureRequest#CONTROL_AF_MODE
990     */
991    public static final int CONTROL_AF_MODE_AUTO = 1;
992
993    /**
994     * <p>Close-up focusing mode.</p>
995     * <p>In this mode, the lens does not move unless the
996     * autofocus trigger action is called. When that trigger is
997     * activated, AF will transition to ACTIVE_SCAN, then to
998     * the outcome of the scan (FOCUSED or NOT_FOCUSED). This
999     * mode is optimized for focusing on objects very close to
1000     * the camera.</p>
1001     * <p>When that trigger is activated, AF will transition to
1002     * ACTIVE_SCAN, then to the outcome of the scan (FOCUSED or
1003     * NOT_FOCUSED). Triggering cancel AF resets the lens
1004     * position to default, and sets the AF state to
1005     * INACTIVE.</p>
1006     * @see CaptureRequest#CONTROL_AF_MODE
1007     */
1008    public static final int CONTROL_AF_MODE_MACRO = 2;
1009
1010    /**
1011     * <p>In this mode, the AF algorithm modifies the lens
1012     * position continually to attempt to provide a
1013     * constantly-in-focus image stream.</p>
1014     * <p>The focusing behavior should be suitable for good quality
1015     * video recording; typically this means slower focus
1016     * movement and no overshoots. When the AF trigger is not
1017     * involved, the AF algorithm should start in INACTIVE state,
1018     * and then transition into PASSIVE_SCAN and PASSIVE_FOCUSED
1019     * states as appropriate. When the AF trigger is activated,
1020     * the algorithm should immediately transition into
1021     * AF_FOCUSED or AF_NOT_FOCUSED as appropriate, and lock the
1022     * lens position until a cancel AF trigger is received.</p>
1023     * <p>Once cancel is received, the algorithm should transition
1024     * back to INACTIVE and resume passive scan. Note that this
1025     * behavior is not identical to CONTINUOUS_PICTURE, since an
1026     * ongoing PASSIVE_SCAN must immediately be
1027     * canceled.</p>
1028     * @see CaptureRequest#CONTROL_AF_MODE
1029     */
1030    public static final int CONTROL_AF_MODE_CONTINUOUS_VIDEO = 3;
1031
1032    /**
1033     * <p>In this mode, the AF algorithm modifies the lens
1034     * position continually to attempt to provide a
1035     * constantly-in-focus image stream.</p>
1036     * <p>The focusing behavior should be suitable for still image
1037     * capture; typically this means focusing as fast as
1038     * possible. When the AF trigger is not involved, the AF
1039     * algorithm should start in INACTIVE state, and then
1040     * transition into PASSIVE_SCAN and PASSIVE_FOCUSED states as
1041     * appropriate as it attempts to maintain focus. When the AF
1042     * trigger is activated, the algorithm should finish its
1043     * PASSIVE_SCAN if active, and then transition into
1044     * AF_FOCUSED or AF_NOT_FOCUSED as appropriate, and lock the
1045     * lens position until a cancel AF trigger is received.</p>
1046     * <p>When the AF cancel trigger is activated, the algorithm
1047     * should transition back to INACTIVE and then act as if it
1048     * has just been started.</p>
1049     * @see CaptureRequest#CONTROL_AF_MODE
1050     */
1051    public static final int CONTROL_AF_MODE_CONTINUOUS_PICTURE = 4;
1052
1053    /**
1054     * <p>Extended depth of field (digital focus) mode.</p>
1055     * <p>The camera device will produce images with an extended
1056     * depth of field automatically; no special focusing
1057     * operations need to be done before taking a picture.</p>
1058     * <p>AF triggers are ignored, and the AF state will always be
1059     * INACTIVE.</p>
1060     * @see CaptureRequest#CONTROL_AF_MODE
1061     */
1062    public static final int CONTROL_AF_MODE_EDOF = 5;
1063
1064    //
1065    // Enumeration values for CaptureRequest#CONTROL_AF_TRIGGER
1066    //
1067
1068    /**
1069     * <p>The trigger is idle.</p>
1070     * @see CaptureRequest#CONTROL_AF_TRIGGER
1071     */
1072    public static final int CONTROL_AF_TRIGGER_IDLE = 0;
1073
1074    /**
1075     * <p>Autofocus will trigger now.</p>
1076     * @see CaptureRequest#CONTROL_AF_TRIGGER
1077     */
1078    public static final int CONTROL_AF_TRIGGER_START = 1;
1079
1080    /**
1081     * <p>Autofocus will return to its initial
1082     * state, and cancel any currently active trigger.</p>
1083     * @see CaptureRequest#CONTROL_AF_TRIGGER
1084     */
1085    public static final int CONTROL_AF_TRIGGER_CANCEL = 2;
1086
1087    //
1088    // Enumeration values for CaptureRequest#CONTROL_AWB_MODE
1089    //
1090
1091    /**
1092     * <p>The camera device's auto-white balance routine is disabled.</p>
1093     * <p>The application-selected color transform matrix
1094     * ({@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}) and gains
1095     * ({@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains}) are used by the camera
1096     * device for manual white balance control.</p>
1097     *
1098     * @see CaptureRequest#COLOR_CORRECTION_GAINS
1099     * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
1100     * @see CaptureRequest#CONTROL_AWB_MODE
1101     */
1102    public static final int CONTROL_AWB_MODE_OFF = 0;
1103
1104    /**
1105     * <p>The camera device's auto-white balance routine is active.</p>
1106     * <p>The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}
1107     * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} are ignored.
1108     * For devices that support the MANUAL_POST_PROCESSING capability, the
1109     * values used by the camera device for the transform and gains
1110     * will be available in the capture result for this request.</p>
1111     *
1112     * @see CaptureRequest#COLOR_CORRECTION_GAINS
1113     * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
1114     * @see CaptureRequest#CONTROL_AWB_MODE
1115     */
1116    public static final int CONTROL_AWB_MODE_AUTO = 1;
1117
1118    /**
1119     * <p>The camera device's auto-white balance routine is disabled;
1120     * the camera device uses incandescent light as the assumed scene
1121     * illumination for white balance.</p>
1122     * <p>While the exact white balance transforms are up to the
1123     * camera device, they will approximately match the CIE
1124     * standard illuminant A.</p>
1125     * <p>The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}
1126     * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} are ignored.
1127     * For devices that support the MANUAL_POST_PROCESSING capability, the
1128     * values used by the camera device for the transform and gains
1129     * will be available in the capture result for this request.</p>
1130     *
1131     * @see CaptureRequest#COLOR_CORRECTION_GAINS
1132     * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
1133     * @see CaptureRequest#CONTROL_AWB_MODE
1134     */
1135    public static final int CONTROL_AWB_MODE_INCANDESCENT = 2;
1136
1137    /**
1138     * <p>The camera device's auto-white balance routine is disabled;
1139     * the camera device uses fluorescent light as the assumed scene
1140     * illumination for white balance.</p>
1141     * <p>While the exact white balance transforms are up to the
1142     * camera device, they will approximately match the CIE
1143     * standard illuminant F2.</p>
1144     * <p>The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}
1145     * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} are ignored.
1146     * For devices that support the MANUAL_POST_PROCESSING capability, the
1147     * values used by the camera device for the transform and gains
1148     * will be available in the capture result for this request.</p>
1149     *
1150     * @see CaptureRequest#COLOR_CORRECTION_GAINS
1151     * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
1152     * @see CaptureRequest#CONTROL_AWB_MODE
1153     */
1154    public static final int CONTROL_AWB_MODE_FLUORESCENT = 3;
1155
1156    /**
1157     * <p>The camera device's auto-white balance routine is disabled;
1158     * the camera device uses warm fluorescent light as the assumed scene
1159     * illumination for white balance.</p>
1160     * <p>While the exact white balance transforms are up to the
1161     * camera device, they will approximately match the CIE
1162     * standard illuminant F4.</p>
1163     * <p>The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}
1164     * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} are ignored.
1165     * For devices that support the MANUAL_POST_PROCESSING capability, the
1166     * values used by the camera device for the transform and gains
1167     * will be available in the capture result for this request.</p>
1168     *
1169     * @see CaptureRequest#COLOR_CORRECTION_GAINS
1170     * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
1171     * @see CaptureRequest#CONTROL_AWB_MODE
1172     */
1173    public static final int CONTROL_AWB_MODE_WARM_FLUORESCENT = 4;
1174
1175    /**
1176     * <p>The camera device's auto-white balance routine is disabled;
1177     * the camera device uses daylight light as the assumed scene
1178     * illumination for white balance.</p>
1179     * <p>While the exact white balance transforms are up to the
1180     * camera device, they will approximately match the CIE
1181     * standard illuminant D65.</p>
1182     * <p>The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}
1183     * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} are ignored.
1184     * For devices that support the MANUAL_POST_PROCESSING capability, the
1185     * values used by the camera device for the transform and gains
1186     * will be available in the capture result for this request.</p>
1187     *
1188     * @see CaptureRequest#COLOR_CORRECTION_GAINS
1189     * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
1190     * @see CaptureRequest#CONTROL_AWB_MODE
1191     */
1192    public static final int CONTROL_AWB_MODE_DAYLIGHT = 5;
1193
1194    /**
1195     * <p>The camera device's auto-white balance routine is disabled;
1196     * the camera device uses cloudy daylight light as the assumed scene
1197     * illumination for white balance.</p>
1198     * <p>The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}
1199     * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} are ignored.
1200     * For devices that support the MANUAL_POST_PROCESSING capability, the
1201     * values used by the camera device for the transform and gains
1202     * will be available in the capture result for this request.</p>
1203     *
1204     * @see CaptureRequest#COLOR_CORRECTION_GAINS
1205     * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
1206     * @see CaptureRequest#CONTROL_AWB_MODE
1207     */
1208    public static final int CONTROL_AWB_MODE_CLOUDY_DAYLIGHT = 6;
1209
1210    /**
1211     * <p>The camera device's auto-white balance routine is disabled;
1212     * the camera device uses twilight light as the assumed scene
1213     * illumination for white balance.</p>
1214     * <p>The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}
1215     * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} are ignored.
1216     * For devices that support the MANUAL_POST_PROCESSING capability, the
1217     * values used by the camera device for the transform and gains
1218     * will be available in the capture result for this request.</p>
1219     *
1220     * @see CaptureRequest#COLOR_CORRECTION_GAINS
1221     * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
1222     * @see CaptureRequest#CONTROL_AWB_MODE
1223     */
1224    public static final int CONTROL_AWB_MODE_TWILIGHT = 7;
1225
1226    /**
1227     * <p>The camera device's auto-white balance routine is disabled;
1228     * the camera device uses shade light as the assumed scene
1229     * illumination for white balance.</p>
1230     * <p>The application's values for {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform}
1231     * and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains} are ignored.
1232     * For devices that support the MANUAL_POST_PROCESSING capability, the
1233     * values used by the camera device for the transform and gains
1234     * will be available in the capture result for this request.</p>
1235     *
1236     * @see CaptureRequest#COLOR_CORRECTION_GAINS
1237     * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
1238     * @see CaptureRequest#CONTROL_AWB_MODE
1239     */
1240    public static final int CONTROL_AWB_MODE_SHADE = 8;
1241
1242    //
1243    // Enumeration values for CaptureRequest#CONTROL_CAPTURE_INTENT
1244    //
1245
1246    /**
1247     * <p>The goal of this request doesn't fall into the other
1248     * categories. The camera device will default to preview-like
1249     * behavior.</p>
1250     * @see CaptureRequest#CONTROL_CAPTURE_INTENT
1251     */
1252    public static final int CONTROL_CAPTURE_INTENT_CUSTOM = 0;
1253
1254    /**
1255     * <p>This request is for a preview-like use case.</p>
1256     * <p>The precapture trigger may be used to start off a metering
1257     * w/flash sequence.</p>
1258     * @see CaptureRequest#CONTROL_CAPTURE_INTENT
1259     */
1260    public static final int CONTROL_CAPTURE_INTENT_PREVIEW = 1;
1261
1262    /**
1263     * <p>This request is for a still capture-type
1264     * use case.</p>
1265     * <p>If the flash unit is under automatic control, it may fire as needed.</p>
1266     * @see CaptureRequest#CONTROL_CAPTURE_INTENT
1267     */
1268    public static final int CONTROL_CAPTURE_INTENT_STILL_CAPTURE = 2;
1269
1270    /**
1271     * <p>This request is for a video recording
1272     * use case.</p>
1273     * @see CaptureRequest#CONTROL_CAPTURE_INTENT
1274     */
1275    public static final int CONTROL_CAPTURE_INTENT_VIDEO_RECORD = 3;
1276
1277    /**
1278     * <p>This request is for a video snapshot (still
1279     * image while recording video) use case.</p>
1280     * <p>The camera device should take the highest-quality image
1281     * possible (given the other settings) without disrupting the
1282     * frame rate of video recording.  </p>
1283     * @see CaptureRequest#CONTROL_CAPTURE_INTENT
1284     */
1285    public static final int CONTROL_CAPTURE_INTENT_VIDEO_SNAPSHOT = 4;
1286
1287    /**
1288     * <p>This request is for a ZSL usecase; the
1289     * application will stream full-resolution images and
1290     * reprocess one or several later for a final
1291     * capture.</p>
1292     * @see CaptureRequest#CONTROL_CAPTURE_INTENT
1293     */
1294    public static final int CONTROL_CAPTURE_INTENT_ZERO_SHUTTER_LAG = 5;
1295
1296    /**
1297     * <p>This request is for manual capture use case where
1298     * the applications want to directly control the capture parameters.</p>
1299     * <p>For example, the application may wish to manually control
1300     * {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}, {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity}, etc.</p>
1301     *
1302     * @see CaptureRequest#SENSOR_EXPOSURE_TIME
1303     * @see CaptureRequest#SENSOR_SENSITIVITY
1304     * @see CaptureRequest#CONTROL_CAPTURE_INTENT
1305     */
1306    public static final int CONTROL_CAPTURE_INTENT_MANUAL = 6;
1307
1308    //
1309    // Enumeration values for CaptureRequest#CONTROL_EFFECT_MODE
1310    //
1311
1312    /**
1313     * <p>No color effect will be applied.</p>
1314     * @see CaptureRequest#CONTROL_EFFECT_MODE
1315     */
1316    public static final int CONTROL_EFFECT_MODE_OFF = 0;
1317
1318    /**
1319     * <p>A "monocolor" effect where the image is mapped into
1320     * a single color.</p>
1321     * <p>This will typically be grayscale.</p>
1322     * @see CaptureRequest#CONTROL_EFFECT_MODE
1323     */
1324    public static final int CONTROL_EFFECT_MODE_MONO = 1;
1325
1326    /**
1327     * <p>A "photo-negative" effect where the image's colors
1328     * are inverted.</p>
1329     * @see CaptureRequest#CONTROL_EFFECT_MODE
1330     */
1331    public static final int CONTROL_EFFECT_MODE_NEGATIVE = 2;
1332
1333    /**
1334     * <p>A "solarisation" effect (Sabattier effect) where the
1335     * image is wholly or partially reversed in
1336     * tone.</p>
1337     * @see CaptureRequest#CONTROL_EFFECT_MODE
1338     */
1339    public static final int CONTROL_EFFECT_MODE_SOLARIZE = 3;
1340
1341    /**
1342     * <p>A "sepia" effect where the image is mapped into warm
1343     * gray, red, and brown tones.</p>
1344     * @see CaptureRequest#CONTROL_EFFECT_MODE
1345     */
1346    public static final int CONTROL_EFFECT_MODE_SEPIA = 4;
1347
1348    /**
1349     * <p>A "posterization" effect where the image uses
1350     * discrete regions of tone rather than a continuous
1351     * gradient of tones.</p>
1352     * @see CaptureRequest#CONTROL_EFFECT_MODE
1353     */
1354    public static final int CONTROL_EFFECT_MODE_POSTERIZE = 5;
1355
1356    /**
1357     * <p>A "whiteboard" effect where the image is typically displayed
1358     * as regions of white, with black or grey details.</p>
1359     * @see CaptureRequest#CONTROL_EFFECT_MODE
1360     */
1361    public static final int CONTROL_EFFECT_MODE_WHITEBOARD = 6;
1362
1363    /**
1364     * <p>A "blackboard" effect where the image is typically displayed
1365     * as regions of black, with white or grey details.</p>
1366     * @see CaptureRequest#CONTROL_EFFECT_MODE
1367     */
1368    public static final int CONTROL_EFFECT_MODE_BLACKBOARD = 7;
1369
1370    /**
1371     * <p>An "aqua" effect where a blue hue is added to the image.</p>
1372     * @see CaptureRequest#CONTROL_EFFECT_MODE
1373     */
1374    public static final int CONTROL_EFFECT_MODE_AQUA = 8;
1375
1376    //
1377    // Enumeration values for CaptureRequest#CONTROL_MODE
1378    //
1379
1380    /**
1381     * <p>Full application control of pipeline.</p>
1382     * <p>All control by the device's metering and focusing (3A)
1383     * routines is disabled, and no other settings in
1384     * android.control.* have any effect, except that
1385     * {@link CaptureRequest#CONTROL_CAPTURE_INTENT android.control.captureIntent} may be used by the camera
1386     * device to select post-processing values for processing
1387     * blocks that do not allow for manual control, or are not
1388     * exposed by the camera API.</p>
1389     * <p>However, the camera device's 3A routines may continue to
1390     * collect statistics and update their internal state so that
1391     * when control is switched to AUTO mode, good control values
1392     * can be immediately applied.</p>
1393     *
1394     * @see CaptureRequest#CONTROL_CAPTURE_INTENT
1395     * @see CaptureRequest#CONTROL_MODE
1396     */
1397    public static final int CONTROL_MODE_OFF = 0;
1398
1399    /**
1400     * <p>Use settings for each individual 3A routine.</p>
1401     * <p>Manual control of capture parameters is disabled. All
1402     * controls in android.control.* besides sceneMode take
1403     * effect.</p>
1404     * @see CaptureRequest#CONTROL_MODE
1405     */
1406    public static final int CONTROL_MODE_AUTO = 1;
1407
1408    /**
1409     * <p>Use a specific scene mode.</p>
1410     * <p>Enabling this disables control.aeMode, control.awbMode and
1411     * control.afMode controls; the camera device will ignore
1412     * those settings while USE_SCENE_MODE is active (except for
1413     * FACE_PRIORITY scene mode). Other control entries are still
1414     * active.  This setting can only be used if scene mode is
1415     * supported (i.e. {@link CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES android.control.availableSceneModes}
1416     * contain some modes other than DISABLED).</p>
1417     *
1418     * @see CameraCharacteristics#CONTROL_AVAILABLE_SCENE_MODES
1419     * @see CaptureRequest#CONTROL_MODE
1420     */
1421    public static final int CONTROL_MODE_USE_SCENE_MODE = 2;
1422
1423    /**
1424     * <p>Same as OFF mode, except that this capture will not be
1425     * used by camera device background auto-exposure, auto-white balance and
1426     * auto-focus algorithms (3A) to update their statistics.</p>
1427     * <p>Specifically, the 3A routines are locked to the last
1428     * values set from a request with AUTO, OFF, or
1429     * USE_SCENE_MODE, and any statistics or state updates
1430     * collected from manual captures with OFF_KEEP_STATE will be
1431     * discarded by the camera device.</p>
1432     * @see CaptureRequest#CONTROL_MODE
1433     */
1434    public static final int CONTROL_MODE_OFF_KEEP_STATE = 3;
1435
1436    //
1437    // Enumeration values for CaptureRequest#CONTROL_SCENE_MODE
1438    //
1439
1440    /**
1441     * <p>Indicates that no scene modes are set for a given capture request.</p>
1442     * @see CaptureRequest#CONTROL_SCENE_MODE
1443     */
1444    public static final int CONTROL_SCENE_MODE_DISABLED = 0;
1445
1446    /**
1447     * <p>If face detection support exists, use face
1448     * detection data for auto-focus, auto-white balance, and
1449     * auto-exposure routines.</p>
1450     * <p>If face detection statistics are disabled
1451     * (i.e. {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} is set to OFF),
1452     * this should still operate correctly (but will not return
1453     * face detection statistics to the framework).</p>
1454     * <p>Unlike the other scene modes, {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode},
1455     * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}, and {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}
1456     * remain active when FACE_PRIORITY is set.</p>
1457     *
1458     * @see CaptureRequest#CONTROL_AE_MODE
1459     * @see CaptureRequest#CONTROL_AF_MODE
1460     * @see CaptureRequest#CONTROL_AWB_MODE
1461     * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE
1462     * @see CaptureRequest#CONTROL_SCENE_MODE
1463     */
1464    public static final int CONTROL_SCENE_MODE_FACE_PRIORITY = 1;
1465
1466    /**
1467     * <p>Optimized for photos of quickly moving objects.</p>
1468     * <p>Similar to SPORTS.</p>
1469     * @see CaptureRequest#CONTROL_SCENE_MODE
1470     */
1471    public static final int CONTROL_SCENE_MODE_ACTION = 2;
1472
1473    /**
1474     * <p>Optimized for still photos of people.</p>
1475     * @see CaptureRequest#CONTROL_SCENE_MODE
1476     */
1477    public static final int CONTROL_SCENE_MODE_PORTRAIT = 3;
1478
1479    /**
1480     * <p>Optimized for photos of distant macroscopic objects.</p>
1481     * @see CaptureRequest#CONTROL_SCENE_MODE
1482     */
1483    public static final int CONTROL_SCENE_MODE_LANDSCAPE = 4;
1484
1485    /**
1486     * <p>Optimized for low-light settings.</p>
1487     * @see CaptureRequest#CONTROL_SCENE_MODE
1488     */
1489    public static final int CONTROL_SCENE_MODE_NIGHT = 5;
1490
1491    /**
1492     * <p>Optimized for still photos of people in low-light
1493     * settings.</p>
1494     * @see CaptureRequest#CONTROL_SCENE_MODE
1495     */
1496    public static final int CONTROL_SCENE_MODE_NIGHT_PORTRAIT = 6;
1497
1498    /**
1499     * <p>Optimized for dim, indoor settings where flash must
1500     * remain off.</p>
1501     * @see CaptureRequest#CONTROL_SCENE_MODE
1502     */
1503    public static final int CONTROL_SCENE_MODE_THEATRE = 7;
1504
1505    /**
1506     * <p>Optimized for bright, outdoor beach settings.</p>
1507     * @see CaptureRequest#CONTROL_SCENE_MODE
1508     */
1509    public static final int CONTROL_SCENE_MODE_BEACH = 8;
1510
1511    /**
1512     * <p>Optimized for bright, outdoor settings containing snow.</p>
1513     * @see CaptureRequest#CONTROL_SCENE_MODE
1514     */
1515    public static final int CONTROL_SCENE_MODE_SNOW = 9;
1516
1517    /**
1518     * <p>Optimized for scenes of the setting sun.</p>
1519     * @see CaptureRequest#CONTROL_SCENE_MODE
1520     */
1521    public static final int CONTROL_SCENE_MODE_SUNSET = 10;
1522
1523    /**
1524     * <p>Optimized to avoid blurry photos due to small amounts of
1525     * device motion (for example: due to hand shake).</p>
1526     * @see CaptureRequest#CONTROL_SCENE_MODE
1527     */
1528    public static final int CONTROL_SCENE_MODE_STEADYPHOTO = 11;
1529
1530    /**
1531     * <p>Optimized for nighttime photos of fireworks.</p>
1532     * @see CaptureRequest#CONTROL_SCENE_MODE
1533     */
1534    public static final int CONTROL_SCENE_MODE_FIREWORKS = 12;
1535
1536    /**
1537     * <p>Optimized for photos of quickly moving people.</p>
1538     * <p>Similar to ACTION.</p>
1539     * @see CaptureRequest#CONTROL_SCENE_MODE
1540     */
1541    public static final int CONTROL_SCENE_MODE_SPORTS = 13;
1542
1543    /**
1544     * <p>Optimized for dim, indoor settings with multiple moving
1545     * people.</p>
1546     * @see CaptureRequest#CONTROL_SCENE_MODE
1547     */
1548    public static final int CONTROL_SCENE_MODE_PARTY = 14;
1549
1550    /**
1551     * <p>Optimized for dim settings where the main light source
1552     * is a flame.</p>
1553     * @see CaptureRequest#CONTROL_SCENE_MODE
1554     */
1555    public static final int CONTROL_SCENE_MODE_CANDLELIGHT = 15;
1556
1557    /**
1558     * <p>Optimized for accurately capturing a photo of barcode
1559     * for use by camera applications that wish to read the
1560     * barcode value.</p>
1561     * @see CaptureRequest#CONTROL_SCENE_MODE
1562     */
1563    public static final int CONTROL_SCENE_MODE_BARCODE = 16;
1564
1565    /**
1566     * <p>Optimized for high speed video recording (frame rate &gt;=60fps) use case.</p>
1567     * <p>The supported high speed video sizes and fps ranges are specified in
1568     * android.control.availableHighSpeedVideoConfigurations. To get desired
1569     * output frame rates, the application is only allowed to select video size
1570     * and fps range combinations listed in this static metadata. The fps range
1571     * can be control via {@link CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE android.control.aeTargetFpsRange}.</p>
1572     * <p>In this mode, the camera device will override aeMode, awbMode, and afMode to
1573     * ON, ON, and CONTINUOUS_VIDEO, respectively. All post-processing block mode
1574     * controls will be overridden to be FAST. Therefore, no manual control of capture
1575     * and post-processing parameters is possible. All other controls operate the
1576     * same as when {@link CaptureRequest#CONTROL_MODE android.control.mode} == AUTO. This means that all other
1577     * android.control.* fields continue to work, such as</p>
1578     * <ul>
1579     * <li>{@link CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE android.control.aeTargetFpsRange}</li>
1580     * <li>{@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation}</li>
1581     * <li>{@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock}</li>
1582     * <li>{@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock}</li>
1583     * <li>{@link CaptureRequest#CONTROL_EFFECT_MODE android.control.effectMode}</li>
1584     * <li>{@link CaptureRequest#CONTROL_AE_REGIONS android.control.aeRegions}</li>
1585     * <li>{@link CaptureRequest#CONTROL_AF_REGIONS android.control.afRegions}</li>
1586     * <li>{@link CaptureRequest#CONTROL_AWB_REGIONS android.control.awbRegions}</li>
1587     * <li>{@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}</li>
1588     * <li>{@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger}</li>
1589     * </ul>
1590     * <p>Outside of android.control.*, the following controls will work:</p>
1591     * <ul>
1592     * <li>{@link CaptureRequest#FLASH_MODE android.flash.mode} (automatic flash for still capture will not work since aeMode is ON)</li>
1593     * <li>{@link CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE android.lens.opticalStabilizationMode} (if it is supported)</li>
1594     * <li>{@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}</li>
1595     * <li>{@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode}</li>
1596     * </ul>
1597     * <p>For high speed recording use case, the actual maximum supported frame rate may
1598     * be lower than what camera can output, depending on the destination Surfaces for
1599     * the image data. For example, if the destination surface is from video encoder,
1600     * the application need check if the video encoder is capable of supporting the
1601     * high frame rate for a given video size, or it will end up with lower recording
1602     * frame rate. If the destination surface is from preview window, the preview frame
1603     * rate will be bounded by the screen refresh rate.</p>
1604     * <p>The camera device will only support up to 2 output high speed streams
1605     * (processed non-stalling format defined in android.request.maxNumOutputStreams)
1606     * in this mode. This control will be effective only if all of below conditions are true:</p>
1607     * <ul>
1608     * <li>The application created no more than maxNumHighSpeedStreams processed non-stalling
1609     * format output streams, where maxNumHighSpeedStreams is calculated as
1610     * min(2, android.request.maxNumOutputStreams[Processed (but not-stalling)]).</li>
1611     * <li>The stream sizes are selected from the sizes reported by
1612     * android.control.availableHighSpeedVideoConfigurations.</li>
1613     * <li>No processed non-stalling or raw streams are configured.</li>
1614     * </ul>
1615     * <p>When above conditions are NOT satistied, the controls of this mode and
1616     * {@link CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE android.control.aeTargetFpsRange} will be ignored by the camera device,
1617     * the camera device will fall back to {@link CaptureRequest#CONTROL_MODE android.control.mode} <code>==</code> AUTO,
1618     * and the returned capture result metadata will give the fps range choosen
1619     * by the camera device.</p>
1620     * <p>Switching into or out of this mode may trigger some camera ISP/sensor
1621     * reconfigurations, which may introduce extra latency. It is recommended that
1622     * the application avoids unnecessary scene mode switch as much as possible.</p>
1623     *
1624     * @see CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION
1625     * @see CaptureRequest#CONTROL_AE_LOCK
1626     * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
1627     * @see CaptureRequest#CONTROL_AE_REGIONS
1628     * @see CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE
1629     * @see CaptureRequest#CONTROL_AF_REGIONS
1630     * @see CaptureRequest#CONTROL_AF_TRIGGER
1631     * @see CaptureRequest#CONTROL_AWB_LOCK
1632     * @see CaptureRequest#CONTROL_AWB_REGIONS
1633     * @see CaptureRequest#CONTROL_EFFECT_MODE
1634     * @see CaptureRequest#CONTROL_MODE
1635     * @see CaptureRequest#FLASH_MODE
1636     * @see CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE
1637     * @see CaptureRequest#SCALER_CROP_REGION
1638     * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE
1639     * @see CaptureRequest#CONTROL_SCENE_MODE
1640     */
1641    public static final int CONTROL_SCENE_MODE_HIGH_SPEED_VIDEO = 17;
1642
1643    /**
1644     * <p>Turn on custom high dynamic range (HDR) mode.</p>
1645     * <p>This is intended for LEGACY mode devices only;
1646     * HAL3+ camera devices should not implement this mode.</p>
1647     * @see CaptureRequest#CONTROL_SCENE_MODE
1648     * @hide
1649     */
1650    public static final int CONTROL_SCENE_MODE_HDR = 18;
1651
1652    //
1653    // Enumeration values for CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE
1654    //
1655
1656    /**
1657     * <p>Video stabilization is disabled.</p>
1658     * @see CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE
1659     */
1660    public static final int CONTROL_VIDEO_STABILIZATION_MODE_OFF = 0;
1661
1662    /**
1663     * <p>Video stabilization is enabled.</p>
1664     * @see CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE
1665     */
1666    public static final int CONTROL_VIDEO_STABILIZATION_MODE_ON = 1;
1667
1668    //
1669    // Enumeration values for CaptureRequest#EDGE_MODE
1670    //
1671
1672    /**
1673     * <p>No edge enhancement is applied.</p>
1674     * @see CaptureRequest#EDGE_MODE
1675     */
1676    public static final int EDGE_MODE_OFF = 0;
1677
1678    /**
1679     * <p>Apply edge enhancement at a quality level that does not slow down frame rate relative to sensor
1680     * output</p>
1681     * @see CaptureRequest#EDGE_MODE
1682     */
1683    public static final int EDGE_MODE_FAST = 1;
1684
1685    /**
1686     * <p>Apply high-quality edge enhancement, at a cost of reducing output frame rate.</p>
1687     * @see CaptureRequest#EDGE_MODE
1688     */
1689    public static final int EDGE_MODE_HIGH_QUALITY = 2;
1690
1691    //
1692    // Enumeration values for CaptureRequest#FLASH_MODE
1693    //
1694
1695    /**
1696     * <p>Do not fire the flash for this capture.</p>
1697     * @see CaptureRequest#FLASH_MODE
1698     */
1699    public static final int FLASH_MODE_OFF = 0;
1700
1701    /**
1702     * <p>If the flash is available and charged, fire flash
1703     * for this capture.</p>
1704     * @see CaptureRequest#FLASH_MODE
1705     */
1706    public static final int FLASH_MODE_SINGLE = 1;
1707
1708    /**
1709     * <p>Transition flash to continuously on.</p>
1710     * @see CaptureRequest#FLASH_MODE
1711     */
1712    public static final int FLASH_MODE_TORCH = 2;
1713
1714    //
1715    // Enumeration values for CaptureRequest#HOT_PIXEL_MODE
1716    //
1717
1718    /**
1719     * <p>No hot pixel correction is applied.</p>
1720     * <p>The frame rate must not be reduced relative to sensor raw output
1721     * for this option.</p>
1722     * <p>The hotpixel map may be returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}.</p>
1723     *
1724     * @see CaptureResult#STATISTICS_HOT_PIXEL_MAP
1725     * @see CaptureRequest#HOT_PIXEL_MODE
1726     */
1727    public static final int HOT_PIXEL_MODE_OFF = 0;
1728
1729    /**
1730     * <p>Hot pixel correction is applied, without reducing frame
1731     * rate relative to sensor raw output.</p>
1732     * <p>The hotpixel map may be returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}.</p>
1733     *
1734     * @see CaptureResult#STATISTICS_HOT_PIXEL_MAP
1735     * @see CaptureRequest#HOT_PIXEL_MODE
1736     */
1737    public static final int HOT_PIXEL_MODE_FAST = 1;
1738
1739    /**
1740     * <p>High-quality hot pixel correction is applied, at a cost
1741     * of reducing frame rate relative to sensor raw output.</p>
1742     * <p>The hotpixel map may be returned in {@link CaptureResult#STATISTICS_HOT_PIXEL_MAP android.statistics.hotPixelMap}.</p>
1743     *
1744     * @see CaptureResult#STATISTICS_HOT_PIXEL_MAP
1745     * @see CaptureRequest#HOT_PIXEL_MODE
1746     */
1747    public static final int HOT_PIXEL_MODE_HIGH_QUALITY = 2;
1748
1749    //
1750    // Enumeration values for CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE
1751    //
1752
1753    /**
1754     * <p>Optical stabilization is unavailable.</p>
1755     * @see CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE
1756     */
1757    public static final int LENS_OPTICAL_STABILIZATION_MODE_OFF = 0;
1758
1759    /**
1760     * <p>Optical stabilization is enabled.</p>
1761     * @see CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE
1762     */
1763    public static final int LENS_OPTICAL_STABILIZATION_MODE_ON = 1;
1764
1765    //
1766    // Enumeration values for CaptureRequest#NOISE_REDUCTION_MODE
1767    //
1768
1769    /**
1770     * <p>No noise reduction is applied.</p>
1771     * @see CaptureRequest#NOISE_REDUCTION_MODE
1772     */
1773    public static final int NOISE_REDUCTION_MODE_OFF = 0;
1774
1775    /**
1776     * <p>Noise reduction is applied without reducing frame rate relative to sensor
1777     * output.</p>
1778     * @see CaptureRequest#NOISE_REDUCTION_MODE
1779     */
1780    public static final int NOISE_REDUCTION_MODE_FAST = 1;
1781
1782    /**
1783     * <p>High-quality noise reduction is applied, at the cost of reducing frame rate
1784     * relative to sensor output.</p>
1785     * @see CaptureRequest#NOISE_REDUCTION_MODE
1786     */
1787    public static final int NOISE_REDUCTION_MODE_HIGH_QUALITY = 2;
1788
1789    //
1790    // Enumeration values for CaptureRequest#SENSOR_TEST_PATTERN_MODE
1791    //
1792
1793    /**
1794     * <p>No test pattern mode is used, and the camera
1795     * device returns captures from the image sensor.</p>
1796     * <p>This is the default if the key is not set.</p>
1797     * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE
1798     */
1799    public static final int SENSOR_TEST_PATTERN_MODE_OFF = 0;
1800
1801    /**
1802     * <p>Each pixel in <code>[R, G_even, G_odd, B]</code> is replaced by its
1803     * respective color channel provided in
1804     * {@link CaptureRequest#SENSOR_TEST_PATTERN_DATA android.sensor.testPatternData}.</p>
1805     * <p>For example:</p>
1806     * <pre><code>android.testPatternData = [0, 0xFFFFFFFF, 0xFFFFFFFF, 0]
1807     * </code></pre>
1808     * <p>All green pixels are 100% green. All red/blue pixels are black.</p>
1809     * <pre><code>android.testPatternData = [0xFFFFFFFF, 0, 0xFFFFFFFF, 0]
1810     * </code></pre>
1811     * <p>All red pixels are 100% red. Only the odd green pixels
1812     * are 100% green. All blue pixels are 100% black.</p>
1813     *
1814     * @see CaptureRequest#SENSOR_TEST_PATTERN_DATA
1815     * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE
1816     */
1817    public static final int SENSOR_TEST_PATTERN_MODE_SOLID_COLOR = 1;
1818
1819    /**
1820     * <p>All pixel data is replaced with an 8-bar color pattern.</p>
1821     * <p>The vertical bars (left-to-right) are as follows:</p>
1822     * <ul>
1823     * <li>100% white</li>
1824     * <li>yellow</li>
1825     * <li>cyan</li>
1826     * <li>green</li>
1827     * <li>magenta</li>
1828     * <li>red</li>
1829     * <li>blue</li>
1830     * <li>black</li>
1831     * </ul>
1832     * <p>In general the image would look like the following:</p>
1833     * <pre><code>W Y C G M R B K
1834     * W Y C G M R B K
1835     * W Y C G M R B K
1836     * W Y C G M R B K
1837     * W Y C G M R B K
1838     * . . . . . . . .
1839     * . . . . . . . .
1840     * . . . . . . . .
1841     *
1842     * (B = Blue, K = Black)
1843     * </code></pre>
1844     * <p>Each bar should take up 1/8 of the sensor pixel array width.
1845     * When this is not possible, the bar size should be rounded
1846     * down to the nearest integer and the pattern can repeat
1847     * on the right side.</p>
1848     * <p>Each bar's height must always take up the full sensor
1849     * pixel array height.</p>
1850     * <p>Each pixel in this test pattern must be set to either
1851     * 0% intensity or 100% intensity.</p>
1852     * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE
1853     */
1854    public static final int SENSOR_TEST_PATTERN_MODE_COLOR_BARS = 2;
1855
1856    /**
1857     * <p>The test pattern is similar to COLOR_BARS, except that
1858     * each bar should start at its specified color at the top,
1859     * and fade to gray at the bottom.</p>
1860     * <p>Furthermore each bar is further subdivided into a left and
1861     * right half. The left half should have a smooth gradient,
1862     * and the right half should have a quantized gradient.</p>
1863     * <p>In particular, the right half's should consist of blocks of the
1864     * same color for 1/16th active sensor pixel array width.</p>
1865     * <p>The least significant bits in the quantized gradient should
1866     * be copied from the most significant bits of the smooth gradient.</p>
1867     * <p>The height of each bar should always be a multiple of 128.
1868     * When this is not the case, the pattern should repeat at the bottom
1869     * of the image.</p>
1870     * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE
1871     */
1872    public static final int SENSOR_TEST_PATTERN_MODE_COLOR_BARS_FADE_TO_GRAY = 3;
1873
1874    /**
1875     * <p>All pixel data is replaced by a pseudo-random sequence
1876     * generated from a PN9 512-bit sequence (typically implemented
1877     * in hardware with a linear feedback shift register).</p>
1878     * <p>The generator should be reset at the beginning of each frame,
1879     * and thus each subsequent raw frame with this test pattern should
1880     * be exactly the same as the last.</p>
1881     * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE
1882     */
1883    public static final int SENSOR_TEST_PATTERN_MODE_PN9 = 4;
1884
1885    /**
1886     * <p>The first custom test pattern. All custom patterns that are
1887     * available only on this camera device are at least this numeric
1888     * value.</p>
1889     * <p>All of the custom test patterns will be static
1890     * (that is the raw image must not vary from frame to frame).</p>
1891     * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE
1892     */
1893    public static final int SENSOR_TEST_PATTERN_MODE_CUSTOM1 = 256;
1894
1895    //
1896    // Enumeration values for CaptureRequest#SHADING_MODE
1897    //
1898
1899    /**
1900     * <p>No lens shading correction is applied.</p>
1901     * @see CaptureRequest#SHADING_MODE
1902     */
1903    public static final int SHADING_MODE_OFF = 0;
1904
1905    /**
1906     * <p>Apply lens shading corrections, without slowing
1907     * frame rate relative to sensor raw output</p>
1908     * @see CaptureRequest#SHADING_MODE
1909     */
1910    public static final int SHADING_MODE_FAST = 1;
1911
1912    /**
1913     * <p>Apply high-quality lens shading correction, at the
1914     * cost of reduced frame rate.</p>
1915     * @see CaptureRequest#SHADING_MODE
1916     */
1917    public static final int SHADING_MODE_HIGH_QUALITY = 2;
1918
1919    //
1920    // Enumeration values for CaptureRequest#STATISTICS_FACE_DETECT_MODE
1921    //
1922
1923    /**
1924     * <p>Do not include face detection statistics in capture
1925     * results.</p>
1926     * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE
1927     */
1928    public static final int STATISTICS_FACE_DETECT_MODE_OFF = 0;
1929
1930    /**
1931     * <p>Return face rectangle and confidence values only.</p>
1932     * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE
1933     */
1934    public static final int STATISTICS_FACE_DETECT_MODE_SIMPLE = 1;
1935
1936    /**
1937     * <p>Return all face
1938     * metadata.</p>
1939     * <p>In this mode, face rectangles, scores, landmarks, and face IDs are all valid.</p>
1940     * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE
1941     */
1942    public static final int STATISTICS_FACE_DETECT_MODE_FULL = 2;
1943
1944    //
1945    // Enumeration values for CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE
1946    //
1947
1948    /**
1949     * <p>Do not include a lens shading map in the capture result.</p>
1950     * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE
1951     */
1952    public static final int STATISTICS_LENS_SHADING_MAP_MODE_OFF = 0;
1953
1954    /**
1955     * <p>Include a lens shading map in the capture result.</p>
1956     * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE
1957     */
1958    public static final int STATISTICS_LENS_SHADING_MAP_MODE_ON = 1;
1959
1960    //
1961    // Enumeration values for CaptureRequest#TONEMAP_MODE
1962    //
1963
1964    /**
1965     * <p>Use the tone mapping curve specified in
1966     * the {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}* entries.</p>
1967     * <p>All color enhancement and tonemapping must be disabled, except
1968     * for applying the tonemapping curve specified by
1969     * {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}.</p>
1970     * <p>Must not slow down frame rate relative to raw
1971     * sensor output.</p>
1972     *
1973     * @see CaptureRequest#TONEMAP_CURVE
1974     * @see CaptureRequest#TONEMAP_MODE
1975     */
1976    public static final int TONEMAP_MODE_CONTRAST_CURVE = 0;
1977
1978    /**
1979     * <p>Advanced gamma mapping and color enhancement may be applied, without
1980     * reducing frame rate compared to raw sensor output.</p>
1981     * @see CaptureRequest#TONEMAP_MODE
1982     */
1983    public static final int TONEMAP_MODE_FAST = 1;
1984
1985    /**
1986     * <p>High-quality gamma mapping and color enhancement will be applied, at
1987     * the cost of reduced frame rate compared to raw sensor output.</p>
1988     * @see CaptureRequest#TONEMAP_MODE
1989     */
1990    public static final int TONEMAP_MODE_HIGH_QUALITY = 2;
1991
1992    //
1993    // Enumeration values for CaptureResult#CONTROL_AE_STATE
1994    //
1995
1996    /**
1997     * <p>AE is off or recently reset.</p>
1998     * <p>When a camera device is opened, it starts in
1999     * this state. This is a transient state, the camera device may skip reporting
2000     * this state in capture result.</p>
2001     * @see CaptureResult#CONTROL_AE_STATE
2002     */
2003    public static final int CONTROL_AE_STATE_INACTIVE = 0;
2004
2005    /**
2006     * <p>AE doesn't yet have a good set of control values
2007     * for the current scene.</p>
2008     * <p>This is a transient state, the camera device may skip
2009     * reporting this state in capture result.</p>
2010     * @see CaptureResult#CONTROL_AE_STATE
2011     */
2012    public static final int CONTROL_AE_STATE_SEARCHING = 1;
2013
2014    /**
2015     * <p>AE has a good set of control values for the
2016     * current scene.</p>
2017     * @see CaptureResult#CONTROL_AE_STATE
2018     */
2019    public static final int CONTROL_AE_STATE_CONVERGED = 2;
2020
2021    /**
2022     * <p>AE has been locked.</p>
2023     * @see CaptureResult#CONTROL_AE_STATE
2024     */
2025    public static final int CONTROL_AE_STATE_LOCKED = 3;
2026
2027    /**
2028     * <p>AE has a good set of control values, but flash
2029     * needs to be fired for good quality still
2030     * capture.</p>
2031     * @see CaptureResult#CONTROL_AE_STATE
2032     */
2033    public static final int CONTROL_AE_STATE_FLASH_REQUIRED = 4;
2034
2035    /**
2036     * <p>AE has been asked to do a precapture sequence
2037     * and is currently executing it.</p>
2038     * <p>Precapture can be triggered through setting
2039     * {@link CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER android.control.aePrecaptureTrigger} to START.</p>
2040     * <p>Once PRECAPTURE completes, AE will transition to CONVERGED
2041     * or FLASH_REQUIRED as appropriate. This is a transient
2042     * state, the camera device may skip reporting this state in
2043     * capture result.</p>
2044     *
2045     * @see CaptureRequest#CONTROL_AE_PRECAPTURE_TRIGGER
2046     * @see CaptureResult#CONTROL_AE_STATE
2047     */
2048    public static final int CONTROL_AE_STATE_PRECAPTURE = 5;
2049
2050    //
2051    // Enumeration values for CaptureResult#CONTROL_AF_STATE
2052    //
2053
2054    /**
2055     * <p>AF is off or has not yet tried to scan/been asked
2056     * to scan.</p>
2057     * <p>When a camera device is opened, it starts in this
2058     * state. This is a transient state, the camera device may
2059     * skip reporting this state in capture
2060     * result.</p>
2061     * @see CaptureResult#CONTROL_AF_STATE
2062     */
2063    public static final int CONTROL_AF_STATE_INACTIVE = 0;
2064
2065    /**
2066     * <p>AF is currently performing an AF scan initiated the
2067     * camera device in a continuous autofocus mode.</p>
2068     * <p>Only used by CONTINUOUS_* AF modes. This is a transient
2069     * state, the camera device may skip reporting this state in
2070     * capture result.</p>
2071     * @see CaptureResult#CONTROL_AF_STATE
2072     */
2073    public static final int CONTROL_AF_STATE_PASSIVE_SCAN = 1;
2074
2075    /**
2076     * <p>AF currently believes it is in focus, but may
2077     * restart scanning at any time.</p>
2078     * <p>Only used by CONTINUOUS_* AF modes. This is a transient
2079     * state, the camera device may skip reporting this state in
2080     * capture result.</p>
2081     * @see CaptureResult#CONTROL_AF_STATE
2082     */
2083    public static final int CONTROL_AF_STATE_PASSIVE_FOCUSED = 2;
2084
2085    /**
2086     * <p>AF is performing an AF scan because it was
2087     * triggered by AF trigger.</p>
2088     * <p>Only used by AUTO or MACRO AF modes. This is a transient
2089     * state, the camera device may skip reporting this state in
2090     * capture result.</p>
2091     * @see CaptureResult#CONTROL_AF_STATE
2092     */
2093    public static final int CONTROL_AF_STATE_ACTIVE_SCAN = 3;
2094
2095    /**
2096     * <p>AF believes it is focused correctly and has locked
2097     * focus.</p>
2098     * <p>This state is reached only after an explicit START AF trigger has been
2099     * sent ({@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}), when good focus has been obtained.</p>
2100     * <p>The lens will remain stationary until the AF mode ({@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}) is changed or
2101     * a new AF trigger is sent to the camera device ({@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}).</p>
2102     *
2103     * @see CaptureRequest#CONTROL_AF_MODE
2104     * @see CaptureRequest#CONTROL_AF_TRIGGER
2105     * @see CaptureResult#CONTROL_AF_STATE
2106     */
2107    public static final int CONTROL_AF_STATE_FOCUSED_LOCKED = 4;
2108
2109    /**
2110     * <p>AF has failed to focus successfully and has locked
2111     * focus.</p>
2112     * <p>This state is reached only after an explicit START AF trigger has been
2113     * sent ({@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}), when good focus cannot be obtained.</p>
2114     * <p>The lens will remain stationary until the AF mode ({@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}) is changed or
2115     * a new AF trigger is sent to the camera device ({@link CaptureRequest#CONTROL_AF_TRIGGER android.control.afTrigger}).</p>
2116     *
2117     * @see CaptureRequest#CONTROL_AF_MODE
2118     * @see CaptureRequest#CONTROL_AF_TRIGGER
2119     * @see CaptureResult#CONTROL_AF_STATE
2120     */
2121    public static final int CONTROL_AF_STATE_NOT_FOCUSED_LOCKED = 5;
2122
2123    /**
2124     * <p>AF finished a passive scan without finding focus,
2125     * and may restart scanning at any time.</p>
2126     * <p>Only used by CONTINUOUS_* AF modes. This is a transient state, the camera
2127     * device may skip reporting this state in capture result.</p>
2128     * <p>LEGACY camera devices do not support this state. When a passive
2129     * scan has finished, it will always go to PASSIVE_FOCUSED.</p>
2130     * @see CaptureResult#CONTROL_AF_STATE
2131     */
2132    public static final int CONTROL_AF_STATE_PASSIVE_UNFOCUSED = 6;
2133
2134    //
2135    // Enumeration values for CaptureResult#CONTROL_AWB_STATE
2136    //
2137
2138    /**
2139     * <p>AWB is not in auto mode, or has not yet started metering.</p>
2140     * <p>When a camera device is opened, it starts in this
2141     * state. This is a transient state, the camera device may
2142     * skip reporting this state in capture
2143     * result.</p>
2144     * @see CaptureResult#CONTROL_AWB_STATE
2145     */
2146    public static final int CONTROL_AWB_STATE_INACTIVE = 0;
2147
2148    /**
2149     * <p>AWB doesn't yet have a good set of control
2150     * values for the current scene.</p>
2151     * <p>This is a transient state, the camera device
2152     * may skip reporting this state in capture result.</p>
2153     * @see CaptureResult#CONTROL_AWB_STATE
2154     */
2155    public static final int CONTROL_AWB_STATE_SEARCHING = 1;
2156
2157    /**
2158     * <p>AWB has a good set of control values for the
2159     * current scene.</p>
2160     * @see CaptureResult#CONTROL_AWB_STATE
2161     */
2162    public static final int CONTROL_AWB_STATE_CONVERGED = 2;
2163
2164    /**
2165     * <p>AWB has been locked.</p>
2166     * @see CaptureResult#CONTROL_AWB_STATE
2167     */
2168    public static final int CONTROL_AWB_STATE_LOCKED = 3;
2169
2170    //
2171    // Enumeration values for CaptureResult#FLASH_STATE
2172    //
2173
2174    /**
2175     * <p>No flash on camera.</p>
2176     * @see CaptureResult#FLASH_STATE
2177     */
2178    public static final int FLASH_STATE_UNAVAILABLE = 0;
2179
2180    /**
2181     * <p>Flash is charging and cannot be fired.</p>
2182     * @see CaptureResult#FLASH_STATE
2183     */
2184    public static final int FLASH_STATE_CHARGING = 1;
2185
2186    /**
2187     * <p>Flash is ready to fire.</p>
2188     * @see CaptureResult#FLASH_STATE
2189     */
2190    public static final int FLASH_STATE_READY = 2;
2191
2192    /**
2193     * <p>Flash fired for this capture.</p>
2194     * @see CaptureResult#FLASH_STATE
2195     */
2196    public static final int FLASH_STATE_FIRED = 3;
2197
2198    /**
2199     * <p>Flash partially illuminated this frame.</p>
2200     * <p>This is usually due to the next or previous frame having
2201     * the flash fire, and the flash spilling into this capture
2202     * due to hardware limitations.</p>
2203     * @see CaptureResult#FLASH_STATE
2204     */
2205    public static final int FLASH_STATE_PARTIAL = 4;
2206
2207    //
2208    // Enumeration values for CaptureResult#LENS_STATE
2209    //
2210
2211    /**
2212     * <p>The lens parameters ({@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance},
2213     * {@link CaptureRequest#LENS_FILTER_DENSITY android.lens.filterDensity} and {@link CaptureRequest#LENS_APERTURE android.lens.aperture}) are not changing.</p>
2214     *
2215     * @see CaptureRequest#LENS_APERTURE
2216     * @see CaptureRequest#LENS_FILTER_DENSITY
2217     * @see CaptureRequest#LENS_FOCAL_LENGTH
2218     * @see CaptureRequest#LENS_FOCUS_DISTANCE
2219     * @see CaptureResult#LENS_STATE
2220     */
2221    public static final int LENS_STATE_STATIONARY = 0;
2222
2223    /**
2224     * <p>One or several of the lens parameters
2225     * ({@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}, {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance},
2226     * {@link CaptureRequest#LENS_FILTER_DENSITY android.lens.filterDensity} or {@link CaptureRequest#LENS_APERTURE android.lens.aperture}) is
2227     * currently changing.</p>
2228     *
2229     * @see CaptureRequest#LENS_APERTURE
2230     * @see CaptureRequest#LENS_FILTER_DENSITY
2231     * @see CaptureRequest#LENS_FOCAL_LENGTH
2232     * @see CaptureRequest#LENS_FOCUS_DISTANCE
2233     * @see CaptureResult#LENS_STATE
2234     */
2235    public static final int LENS_STATE_MOVING = 1;
2236
2237    //
2238    // Enumeration values for CaptureResult#STATISTICS_SCENE_FLICKER
2239    //
2240
2241    /**
2242     * <p>The camera device does not detect any flickering illumination
2243     * in the current scene.</p>
2244     * @see CaptureResult#STATISTICS_SCENE_FLICKER
2245     */
2246    public static final int STATISTICS_SCENE_FLICKER_NONE = 0;
2247
2248    /**
2249     * <p>The camera device detects illumination flickering at 50Hz
2250     * in the current scene.</p>
2251     * @see CaptureResult#STATISTICS_SCENE_FLICKER
2252     */
2253    public static final int STATISTICS_SCENE_FLICKER_50HZ = 1;
2254
2255    /**
2256     * <p>The camera device detects illumination flickering at 60Hz
2257     * in the current scene.</p>
2258     * @see CaptureResult#STATISTICS_SCENE_FLICKER
2259     */
2260    public static final int STATISTICS_SCENE_FLICKER_60HZ = 2;
2261
2262    //
2263    // Enumeration values for CaptureResult#SYNC_FRAME_NUMBER
2264    //
2265
2266    /**
2267     * <p>The current result is not yet fully synchronized to any request.</p>
2268     * <p>Synchronization is in progress, and reading metadata from this
2269     * result may include a mix of data that have taken effect since the
2270     * last synchronization time.</p>
2271     * <p>In some future result, within {@link CameraCharacteristics#SYNC_MAX_LATENCY android.sync.maxLatency} frames,
2272     * this value will update to the actual frame number frame number
2273     * the result is guaranteed to be synchronized to (as long as the
2274     * request settings remain constant).</p>
2275     *
2276     * @see CameraCharacteristics#SYNC_MAX_LATENCY
2277     * @see CaptureResult#SYNC_FRAME_NUMBER
2278     * @hide
2279     */
2280    public static final int SYNC_FRAME_NUMBER_CONVERGING = -1;
2281
2282    /**
2283     * <p>The current result's synchronization status is unknown.</p>
2284     * <p>The result may have already converged, or it may be in
2285     * progress.  Reading from this result may include some mix
2286     * of settings from past requests.</p>
2287     * <p>After a settings change, the new settings will eventually all
2288     * take effect for the output buffers and results. However, this
2289     * value will not change when that happens. Altering settings
2290     * rapidly may provide outcomes using mixes of settings from recent
2291     * requests.</p>
2292     * <p>This value is intended primarily for backwards compatibility with
2293     * the older camera implementations (for android.hardware.Camera).</p>
2294     * @see CaptureResult#SYNC_FRAME_NUMBER
2295     * @hide
2296     */
2297    public static final int SYNC_FRAME_NUMBER_UNKNOWN = -2;
2298
2299    /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~
2300     * End generated code
2301     *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/
2302
2303}
2304