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