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