CameraCharacteristics.java revision 02cd8cbc9df749f9dbf5f4bcb2159c07a63b5a2f
1/*
2 * Copyright (C) 2013 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.hardware.camera2;
18
19import android.annotation.NonNull;
20import android.annotation.Nullable;
21import android.hardware.camera2.impl.CameraMetadataNative;
22import android.hardware.camera2.impl.PublicKey;
23import android.hardware.camera2.impl.SyntheticKey;
24import android.hardware.camera2.utils.TypeReference;
25import android.util.Rational;
26
27import java.util.Collections;
28import java.util.List;
29
30/**
31 * <p>The properties describing a
32 * {@link CameraDevice CameraDevice}.</p>
33 *
34 * <p>These properties are fixed for a given CameraDevice, and can be queried
35 * through the {@link CameraManager CameraManager}
36 * interface with {@link CameraManager#getCameraCharacteristics}.</p>
37 *
38 * <p>{@link CameraCharacteristics} objects are immutable.</p>
39 *
40 * @see CameraDevice
41 * @see CameraManager
42 */
43public final class CameraCharacteristics extends CameraMetadata<CameraCharacteristics.Key<?>> {
44
45    /**
46     * A {@code Key} is used to do camera characteristics field lookups with
47     * {@link CameraCharacteristics#get}.
48     *
49     * <p>For example, to get the stream configuration map:
50     * <code><pre>
51     * StreamConfigurationMap map = cameraCharacteristics.get(
52     *      CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP);
53     * </pre></code>
54     * </p>
55     *
56     * <p>To enumerate over all possible keys for {@link CameraCharacteristics}, see
57     * {@link CameraCharacteristics#getKeys()}.</p>
58     *
59     * @see CameraCharacteristics#get
60     * @see CameraCharacteristics#getKeys()
61     */
62    public static final class Key<T> {
63        private final CameraMetadataNative.Key<T> mKey;
64
65        /**
66         * Visible for testing and vendor extensions only.
67         *
68         * @hide
69         */
70        public Key(String name, Class<T> type) {
71            mKey = new CameraMetadataNative.Key<T>(name,  type);
72        }
73
74        /**
75         * Visible for testing and vendor extensions only.
76         *
77         * @hide
78         */
79        public Key(String name, TypeReference<T> typeReference) {
80            mKey = new CameraMetadataNative.Key<T>(name,  typeReference);
81        }
82
83        /**
84         * Return a camelCase, period separated name formatted like:
85         * {@code "root.section[.subsections].name"}.
86         *
87         * <p>Built-in keys exposed by the Android SDK are always prefixed with {@code "android."};
88         * keys that are device/platform-specific are prefixed with {@code "com."}.</p>
89         *
90         * <p>For example, {@code CameraCharacteristics.SCALER_STREAM_CONFIGURATION_MAP} would
91         * have a name of {@code "android.scaler.streamConfigurationMap"}; whereas a device
92         * specific key might look like {@code "com.google.nexus.data.private"}.</p>
93         *
94         * @return String representation of the key name
95         */
96        @NonNull
97        public String getName() {
98            return mKey.getName();
99        }
100
101        /**
102         * {@inheritDoc}
103         */
104        @Override
105        public final int hashCode() {
106            return mKey.hashCode();
107        }
108
109        /**
110         * {@inheritDoc}
111         */
112        @SuppressWarnings("unchecked")
113        @Override
114        public final boolean equals(Object o) {
115            return o instanceof Key && ((Key<T>)o).mKey.equals(mKey);
116        }
117
118        /**
119         * Visible for CameraMetadataNative implementation only; do not use.
120         *
121         * TODO: Make this private or remove it altogether.
122         *
123         * @hide
124         */
125        public CameraMetadataNative.Key<T> getNativeKey() {
126            return mKey;
127        }
128
129        @SuppressWarnings({
130                "unused", "unchecked"
131        })
132        private Key(CameraMetadataNative.Key<?> nativeKey) {
133            mKey = (CameraMetadataNative.Key<T>) nativeKey;
134        }
135    }
136
137    private final CameraMetadataNative mProperties;
138    private List<CameraCharacteristics.Key<?>> mKeys;
139    private List<CaptureRequest.Key<?>> mAvailableRequestKeys;
140    private List<CaptureResult.Key<?>> mAvailableResultKeys;
141
142    /**
143     * Takes ownership of the passed-in properties object
144     * @hide
145     */
146    public CameraCharacteristics(CameraMetadataNative properties) {
147        mProperties = CameraMetadataNative.move(properties);
148    }
149
150    /**
151     * Returns a copy of the underlying {@link CameraMetadataNative}.
152     * @hide
153     */
154    public CameraMetadataNative getNativeCopy() {
155        return new CameraMetadataNative(mProperties);
156    }
157
158    /**
159     * Get a camera characteristics field value.
160     *
161     * <p>The field definitions can be
162     * found in {@link CameraCharacteristics}.</p>
163     *
164     * <p>Querying the value for the same key more than once will return a value
165     * which is equal to the previous queried value.</p>
166     *
167     * @throws IllegalArgumentException if the key was not valid
168     *
169     * @param key The characteristics field to read.
170     * @return The value of that key, or {@code null} if the field is not set.
171     */
172    @Nullable
173    public <T> T get(Key<T> key) {
174        return mProperties.get(key);
175    }
176
177    /**
178     * {@inheritDoc}
179     * @hide
180     */
181    @SuppressWarnings("unchecked")
182    @Override
183    protected <T> T getProtected(Key<?> key) {
184        return (T) mProperties.get(key);
185    }
186
187    /**
188     * {@inheritDoc}
189     * @hide
190     */
191    @SuppressWarnings("unchecked")
192    @Override
193    protected Class<Key<?>> getKeyClass() {
194        Object thisClass = Key.class;
195        return (Class<Key<?>>)thisClass;
196    }
197
198    /**
199     * {@inheritDoc}
200     */
201    @NonNull
202    @Override
203    public List<Key<?>> getKeys() {
204        // List of keys is immutable; cache the results after we calculate them
205        if (mKeys != null) {
206            return mKeys;
207        }
208
209        int[] filterTags = get(REQUEST_AVAILABLE_CHARACTERISTICS_KEYS);
210        if (filterTags == null) {
211            throw new AssertionError("android.request.availableCharacteristicsKeys must be non-null"
212                    + " in the characteristics");
213        }
214
215        mKeys = Collections.unmodifiableList(
216                getKeysStatic(getClass(), getKeyClass(), this, filterTags));
217        return mKeys;
218    }
219
220    /**
221     * Returns the list of keys supported by this {@link CameraDevice} for querying
222     * with a {@link CaptureRequest}.
223     *
224     * <p>The list returned is not modifiable, so any attempts to modify it will throw
225     * a {@code UnsupportedOperationException}.</p>
226     *
227     * <p>Each key is only listed once in the list. The order of the keys is undefined.</p>
228     *
229     * <p>Note that there is no {@code getAvailableCameraCharacteristicsKeys()} -- use
230     * {@link #getKeys()} instead.</p>
231     *
232     * @return List of keys supported by this CameraDevice for CaptureRequests.
233     */
234    @SuppressWarnings({"unchecked"})
235    @NonNull
236    public List<CaptureRequest.Key<?>> getAvailableCaptureRequestKeys() {
237        if (mAvailableRequestKeys == null) {
238            Object crKey = CaptureRequest.Key.class;
239            Class<CaptureRequest.Key<?>> crKeyTyped = (Class<CaptureRequest.Key<?>>)crKey;
240
241            int[] filterTags = get(REQUEST_AVAILABLE_REQUEST_KEYS);
242            if (filterTags == null) {
243                throw new AssertionError("android.request.availableRequestKeys must be non-null "
244                        + "in the characteristics");
245            }
246            mAvailableRequestKeys =
247                    getAvailableKeyList(CaptureRequest.class, crKeyTyped, filterTags);
248        }
249        return mAvailableRequestKeys;
250    }
251
252    /**
253     * Returns the list of keys supported by this {@link CameraDevice} for querying
254     * with a {@link CaptureResult}.
255     *
256     * <p>The list returned is not modifiable, so any attempts to modify it will throw
257     * a {@code UnsupportedOperationException}.</p>
258     *
259     * <p>Each key is only listed once in the list. The order of the keys is undefined.</p>
260     *
261     * <p>Note that there is no {@code getAvailableCameraCharacteristicsKeys()} -- use
262     * {@link #getKeys()} instead.</p>
263     *
264     * @return List of keys supported by this CameraDevice for CaptureResults.
265     */
266    @SuppressWarnings({"unchecked"})
267    @NonNull
268    public List<CaptureResult.Key<?>> getAvailableCaptureResultKeys() {
269        if (mAvailableResultKeys == null) {
270            Object crKey = CaptureResult.Key.class;
271            Class<CaptureResult.Key<?>> crKeyTyped = (Class<CaptureResult.Key<?>>)crKey;
272
273            int[] filterTags = get(REQUEST_AVAILABLE_RESULT_KEYS);
274            if (filterTags == null) {
275                throw new AssertionError("android.request.availableResultKeys must be non-null "
276                        + "in the characteristics");
277            }
278            mAvailableResultKeys = getAvailableKeyList(CaptureResult.class, crKeyTyped, filterTags);
279        }
280        return mAvailableResultKeys;
281    }
282
283    /**
284     * Returns the list of keys supported by this {@link CameraDevice} by metadataClass.
285     *
286     * <p>The list returned is not modifiable, so any attempts to modify it will throw
287     * a {@code UnsupportedOperationException}.</p>
288     *
289     * <p>Each key is only listed once in the list. The order of the keys is undefined.</p>
290     *
291     * @param metadataClass The subclass of CameraMetadata that you want to get the keys for.
292     * @param keyClass The class of the metadata key, e.g. CaptureRequest.Key.class
293     *
294     * @return List of keys supported by this CameraDevice for metadataClass.
295     *
296     * @throws IllegalArgumentException if metadataClass is not a subclass of CameraMetadata
297     */
298    private <TKey> List<TKey>
299    getAvailableKeyList(Class<?> metadataClass, Class<TKey> keyClass, int[] filterTags) {
300
301        if (metadataClass.equals(CameraMetadata.class)) {
302            throw new AssertionError(
303                    "metadataClass must be a strict subclass of CameraMetadata");
304        } else if (!CameraMetadata.class.isAssignableFrom(metadataClass)) {
305            throw new AssertionError(
306                    "metadataClass must be a subclass of CameraMetadata");
307        }
308
309        List<TKey> staticKeyList = CameraCharacteristics.<TKey>getKeysStatic(
310                metadataClass, keyClass, /*instance*/null, filterTags);
311        return Collections.unmodifiableList(staticKeyList);
312    }
313
314    /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~
315     * The key entries below this point are generated from metadata
316     * definitions in /system/media/camera/docs. Do not modify by hand or
317     * modify the comment blocks at the start or end.
318     *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/
319
320    /**
321     * <p>List of aberration correction modes for {@link CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE android.colorCorrection.aberrationMode} that are
322     * supported by this camera device.</p>
323     * <p>This key lists the valid modes for {@link CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE android.colorCorrection.aberrationMode}.  If no
324     * aberration correction modes are available for a device, this list will solely include
325     * OFF mode. All camera devices will support either OFF or FAST mode.</p>
326     * <p>Camera devices that support the MANUAL_POST_PROCESSING capability will always list
327     * OFF mode. This includes all FULL level devices.</p>
328     * <p>LEGACY devices will always only support FAST mode.</p>
329     * <p><b>Range of valid values:</b><br>
330     * Any value listed in {@link CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE android.colorCorrection.aberrationMode}</p>
331     * <p>This key is available on all devices.</p>
332     *
333     * @see CaptureRequest#COLOR_CORRECTION_ABERRATION_MODE
334     */
335    @PublicKey
336    public static final Key<int[]> COLOR_CORRECTION_AVAILABLE_ABERRATION_MODES =
337            new Key<int[]>("android.colorCorrection.availableAberrationModes", int[].class);
338
339    /**
340     * <p>List of auto-exposure antibanding modes for {@link CaptureRequest#CONTROL_AE_ANTIBANDING_MODE android.control.aeAntibandingMode} that are
341     * supported by this camera device.</p>
342     * <p>Not all of the auto-exposure anti-banding modes may be
343     * supported by a given camera device. This field lists the
344     * valid anti-banding modes that the application may request
345     * for this camera device with the
346     * {@link CaptureRequest#CONTROL_AE_ANTIBANDING_MODE android.control.aeAntibandingMode} control.</p>
347     * <p><b>Range of valid values:</b><br>
348     * Any value listed in {@link CaptureRequest#CONTROL_AE_ANTIBANDING_MODE android.control.aeAntibandingMode}</p>
349     * <p>This key is available on all devices.</p>
350     *
351     * @see CaptureRequest#CONTROL_AE_ANTIBANDING_MODE
352     */
353    @PublicKey
354    public static final Key<int[]> CONTROL_AE_AVAILABLE_ANTIBANDING_MODES =
355            new Key<int[]>("android.control.aeAvailableAntibandingModes", int[].class);
356
357    /**
358     * <p>List of auto-exposure modes for {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} that are supported by this camera
359     * device.</p>
360     * <p>Not all the auto-exposure modes may be supported by a
361     * given camera device, especially if no flash unit is
362     * available. This entry lists the valid modes for
363     * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} for this camera device.</p>
364     * <p>All camera devices support ON, and all camera devices with flash
365     * units support ON_AUTO_FLASH and ON_ALWAYS_FLASH.</p>
366     * <p>FULL mode camera devices always support OFF mode,
367     * which enables application control of camera exposure time,
368     * sensitivity, and frame duration.</p>
369     * <p>LEGACY mode camera devices never support OFF mode.
370     * LIMITED mode devices support OFF if they support the MANUAL_SENSOR
371     * capability.</p>
372     * <p><b>Range of valid values:</b><br>
373     * Any value listed in {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode}</p>
374     * <p>This key is available on all devices.</p>
375     *
376     * @see CaptureRequest#CONTROL_AE_MODE
377     */
378    @PublicKey
379    public static final Key<int[]> CONTROL_AE_AVAILABLE_MODES =
380            new Key<int[]>("android.control.aeAvailableModes", int[].class);
381
382    /**
383     * <p>List of frame rate ranges for {@link CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE android.control.aeTargetFpsRange} supported by
384     * this camera device.</p>
385     * <p>For devices at the LEGACY level or above:</p>
386     * <ul>
387     * <li>This list will always include (30, 30).</li>
388     * <li>Also, for constant-framerate recording, for each normal
389     * {@link android.media.CamcorderProfile CamcorderProfile} that has
390     * {@link android.media.CamcorderProfile#quality quality} in
391     * the range [{@link android.media.CamcorderProfile#QUALITY_LOW QUALITY_LOW},
392     * {@link android.media.CamcorderProfile#QUALITY_2160P QUALITY_2160P}], if the profile is
393     * supported by the device and has
394     * {@link android.media.CamcorderProfile#videoFrameRate videoFrameRate} <code>x</code>, this list will
395     * always include (<code>x</code>,<code>x</code>).</li>
396     * <li>For preview streaming use case, this list will always include (<code>min</code>, <code>max</code>) where
397     * <code>min</code> &lt;= 15 and <code>max</code> &gt;= 30.</li>
398     * </ul>
399     * <p>For devices at the LIMITED level or above:</p>
400     * <ul>
401     * <li>For YUV_420_888 burst capture use case, this list will always include (<code>min</code>, <code>max</code>)
402     * and (<code>max</code>, <code>max</code>) where <code>min</code> &lt;= 15 and <code>max</code> = the maximum output frame rate of the
403     * maximum YUV_420_888 output size.</li>
404     * </ul>
405     * <p><b>Units</b>: Frames per second (FPS)</p>
406     * <p>This key is available on all devices.</p>
407     *
408     * @see CaptureRequest#CONTROL_AE_TARGET_FPS_RANGE
409     */
410    @PublicKey
411    public static final Key<android.util.Range<Integer>[]> CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES =
412            new Key<android.util.Range<Integer>[]>("android.control.aeAvailableTargetFpsRanges", new TypeReference<android.util.Range<Integer>[]>() {{ }});
413
414    /**
415     * <p>Maximum and minimum exposure compensation values for
416     * {@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation}, in counts of {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP android.control.aeCompensationStep},
417     * that are supported by this camera device.</p>
418     * <p><b>Range of valid values:</b><br></p>
419     * <p>Range [0,0] indicates that exposure compensation is not supported.</p>
420     * <p>For LIMITED and FULL devices, range must follow below requirements if exposure
421     * compensation is supported (<code>range != [0, 0]</code>):</p>
422     * <p><code>Min.exposure compensation * {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP android.control.aeCompensationStep} &lt;= -2 EV</code></p>
423     * <p><code>Max.exposure compensation * {@link CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP android.control.aeCompensationStep} &gt;= 2 EV</code></p>
424     * <p>LEGACY devices may support a smaller range than this.</p>
425     * <p>This key is available on all devices.</p>
426     *
427     * @see CameraCharacteristics#CONTROL_AE_COMPENSATION_STEP
428     * @see CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION
429     */
430    @PublicKey
431    public static final Key<android.util.Range<Integer>> CONTROL_AE_COMPENSATION_RANGE =
432            new Key<android.util.Range<Integer>>("android.control.aeCompensationRange", new TypeReference<android.util.Range<Integer>>() {{ }});
433
434    /**
435     * <p>Smallest step by which the exposure compensation
436     * can be changed.</p>
437     * <p>This is the unit for {@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation}. For example, if this key has
438     * a value of <code>1/2</code>, then a setting of <code>-2</code> for {@link CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION android.control.aeExposureCompensation} means
439     * that the target EV offset for the auto-exposure routine is -1 EV.</p>
440     * <p>One unit of EV compensation changes the brightness of the captured image by a factor
441     * of two. +1 EV doubles the image brightness, while -1 EV halves the image brightness.</p>
442     * <p><b>Units</b>: Exposure Value (EV)</p>
443     * <p>This key is available on all devices.</p>
444     *
445     * @see CaptureRequest#CONTROL_AE_EXPOSURE_COMPENSATION
446     */
447    @PublicKey
448    public static final Key<Rational> CONTROL_AE_COMPENSATION_STEP =
449            new Key<Rational>("android.control.aeCompensationStep", Rational.class);
450
451    /**
452     * <p>List of auto-focus (AF) modes for {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} that are
453     * supported by this camera device.</p>
454     * <p>Not all the auto-focus modes may be supported by a
455     * given camera device. This entry lists the valid modes for
456     * {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} for this camera device.</p>
457     * <p>All LIMITED and FULL mode camera devices will support OFF mode, and all
458     * camera devices with adjustable focuser units
459     * (<code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} &gt; 0</code>) will support AUTO mode.</p>
460     * <p>LEGACY devices will support OFF mode only if they support
461     * focusing to infinity (by also setting {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance} to
462     * <code>0.0f</code>).</p>
463     * <p><b>Range of valid values:</b><br>
464     * Any value listed in {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}</p>
465     * <p>This key is available on all devices.</p>
466     *
467     * @see CaptureRequest#CONTROL_AF_MODE
468     * @see CaptureRequest#LENS_FOCUS_DISTANCE
469     * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE
470     */
471    @PublicKey
472    public static final Key<int[]> CONTROL_AF_AVAILABLE_MODES =
473            new Key<int[]>("android.control.afAvailableModes", int[].class);
474
475    /**
476     * <p>List of color effects for {@link CaptureRequest#CONTROL_EFFECT_MODE android.control.effectMode} that are supported by this camera
477     * device.</p>
478     * <p>This list contains the color effect modes that can be applied to
479     * images produced by the camera device.
480     * Implementations are not expected to be consistent across all devices.
481     * If no color effect modes are available for a device, this will only list
482     * OFF.</p>
483     * <p>A color effect will only be applied if
484     * {@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF.  OFF is always included in this list.</p>
485     * <p>This control has no effect on the operation of other control routines such
486     * as auto-exposure, white balance, or focus.</p>
487     * <p><b>Range of valid values:</b><br>
488     * Any value listed in {@link CaptureRequest#CONTROL_EFFECT_MODE android.control.effectMode}</p>
489     * <p>This key is available on all devices.</p>
490     *
491     * @see CaptureRequest#CONTROL_EFFECT_MODE
492     * @see CaptureRequest#CONTROL_MODE
493     */
494    @PublicKey
495    public static final Key<int[]> CONTROL_AVAILABLE_EFFECTS =
496            new Key<int[]>("android.control.availableEffects", int[].class);
497
498    /**
499     * <p>List of scene modes for {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode} that are supported by this camera
500     * device.</p>
501     * <p>This list contains scene modes that can be set for the camera device.
502     * Only scene modes that have been fully implemented for the
503     * camera device may be included here. Implementations are not expected
504     * to be consistent across all devices.</p>
505     * <p>If no scene modes are supported by the camera device, this
506     * will be set to DISABLED. Otherwise DISABLED will not be listed.</p>
507     * <p>FACE_PRIORITY is always listed if face detection is
508     * supported (i.e.<code>{@link CameraCharacteristics#STATISTICS_INFO_MAX_FACE_COUNT android.statistics.info.maxFaceCount} &gt;
509     * 0</code>).</p>
510     * <p><b>Range of valid values:</b><br>
511     * Any value listed in {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode}</p>
512     * <p>This key is available on all devices.</p>
513     *
514     * @see CaptureRequest#CONTROL_SCENE_MODE
515     * @see CameraCharacteristics#STATISTICS_INFO_MAX_FACE_COUNT
516     */
517    @PublicKey
518    public static final Key<int[]> CONTROL_AVAILABLE_SCENE_MODES =
519            new Key<int[]>("android.control.availableSceneModes", int[].class);
520
521    /**
522     * <p>List of video stabilization modes for {@link CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}
523     * that are supported by this camera device.</p>
524     * <p>OFF will always be listed.</p>
525     * <p><b>Range of valid values:</b><br>
526     * Any value listed in {@link CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE android.control.videoStabilizationMode}</p>
527     * <p>This key is available on all devices.</p>
528     *
529     * @see CaptureRequest#CONTROL_VIDEO_STABILIZATION_MODE
530     */
531    @PublicKey
532    public static final Key<int[]> CONTROL_AVAILABLE_VIDEO_STABILIZATION_MODES =
533            new Key<int[]>("android.control.availableVideoStabilizationModes", int[].class);
534
535    /**
536     * <p>List of auto-white-balance modes for {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} that are supported by this
537     * camera device.</p>
538     * <p>Not all the auto-white-balance modes may be supported by a
539     * given camera device. This entry lists the valid modes for
540     * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} for this camera device.</p>
541     * <p>All camera devices will support ON mode.</p>
542     * <p>Camera devices that support the MANUAL_POST_PROCESSING capability will always support OFF
543     * mode, which enables application control of white balance, by using
544     * {@link CaptureRequest#COLOR_CORRECTION_TRANSFORM android.colorCorrection.transform} and {@link CaptureRequest#COLOR_CORRECTION_GAINS android.colorCorrection.gains}({@link CaptureRequest#COLOR_CORRECTION_MODE android.colorCorrection.mode} must be set to TRANSFORM_MATRIX). This includes all FULL
545     * mode camera devices.</p>
546     * <p><b>Range of valid values:</b><br>
547     * Any value listed in {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode}</p>
548     * <p>This key is available on all devices.</p>
549     *
550     * @see CaptureRequest#COLOR_CORRECTION_GAINS
551     * @see CaptureRequest#COLOR_CORRECTION_MODE
552     * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
553     * @see CaptureRequest#CONTROL_AWB_MODE
554     */
555    @PublicKey
556    public static final Key<int[]> CONTROL_AWB_AVAILABLE_MODES =
557            new Key<int[]>("android.control.awbAvailableModes", int[].class);
558
559    /**
560     * <p>List of the maximum number of regions that can be used for metering in
561     * auto-exposure (AE), auto-white balance (AWB), and auto-focus (AF);
562     * this corresponds to the the maximum number of elements in
563     * {@link CaptureRequest#CONTROL_AE_REGIONS android.control.aeRegions}, {@link CaptureRequest#CONTROL_AWB_REGIONS android.control.awbRegions},
564     * and {@link CaptureRequest#CONTROL_AF_REGIONS android.control.afRegions}.</p>
565     * <p><b>Range of valid values:</b><br></p>
566     * <p>Value must be &gt;= 0 for each element. For full-capability devices
567     * this value must be &gt;= 1 for AE and AF. The order of the elements is:
568     * <code>(AE, AWB, AF)</code>.</p>
569     * <p>This key is available on all devices.</p>
570     *
571     * @see CaptureRequest#CONTROL_AE_REGIONS
572     * @see CaptureRequest#CONTROL_AF_REGIONS
573     * @see CaptureRequest#CONTROL_AWB_REGIONS
574     * @hide
575     */
576    public static final Key<int[]> CONTROL_MAX_REGIONS =
577            new Key<int[]>("android.control.maxRegions", int[].class);
578
579    /**
580     * <p>The maximum number of metering regions that can be used by the auto-exposure (AE)
581     * routine.</p>
582     * <p>This corresponds to the the maximum allowed number of elements in
583     * {@link CaptureRequest#CONTROL_AE_REGIONS android.control.aeRegions}.</p>
584     * <p><b>Range of valid values:</b><br>
585     * Value will be &gt;= 0. For FULL-capability devices, this
586     * value will be &gt;= 1.</p>
587     * <p>This key is available on all devices.</p>
588     *
589     * @see CaptureRequest#CONTROL_AE_REGIONS
590     */
591    @PublicKey
592    @SyntheticKey
593    public static final Key<Integer> CONTROL_MAX_REGIONS_AE =
594            new Key<Integer>("android.control.maxRegionsAe", int.class);
595
596    /**
597     * <p>The maximum number of metering regions that can be used by the auto-white balance (AWB)
598     * routine.</p>
599     * <p>This corresponds to the the maximum allowed number of elements in
600     * {@link CaptureRequest#CONTROL_AWB_REGIONS android.control.awbRegions}.</p>
601     * <p><b>Range of valid values:</b><br>
602     * Value will be &gt;= 0.</p>
603     * <p>This key is available on all devices.</p>
604     *
605     * @see CaptureRequest#CONTROL_AWB_REGIONS
606     */
607    @PublicKey
608    @SyntheticKey
609    public static final Key<Integer> CONTROL_MAX_REGIONS_AWB =
610            new Key<Integer>("android.control.maxRegionsAwb", int.class);
611
612    /**
613     * <p>The maximum number of metering regions that can be used by the auto-focus (AF) routine.</p>
614     * <p>This corresponds to the the maximum allowed number of elements in
615     * {@link CaptureRequest#CONTROL_AF_REGIONS android.control.afRegions}.</p>
616     * <p><b>Range of valid values:</b><br>
617     * Value will be &gt;= 0. For FULL-capability devices, this
618     * value will be &gt;= 1.</p>
619     * <p>This key is available on all devices.</p>
620     *
621     * @see CaptureRequest#CONTROL_AF_REGIONS
622     */
623    @PublicKey
624    @SyntheticKey
625    public static final Key<Integer> CONTROL_MAX_REGIONS_AF =
626            new Key<Integer>("android.control.maxRegionsAf", int.class);
627
628    /**
629     * <p>List of available high speed video size, fps range and max batch size configurations
630     * supported by the camera device, in the format of (width, height, fps_min, fps_max, batch_size_max).</p>
631     * <p>When CONSTRAINED_HIGH_SPEED_VIDEO is supported in android.control.availableCapabilities,
632     * this metadata will list the supported high speed video size, fps range and max batch size
633     * configurations. All the sizes listed in this configuration will be a subset of the sizes
634     * reported by {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes }
635     * for processed non-stalling formats.</p>
636     * <p>For the high speed video use case, the application must
637     * select the video size and fps range from this metadata to configure the recording and
638     * preview streams and setup the recording requests. For example, if the application intends
639     * to do high speed recording, it can select the maximum size reported by this metadata to
640     * configure output streams. Once the size is selected, application can filter this metadata
641     * by selected size and get the supported fps ranges, and use these fps ranges to setup the
642     * recording requests. Note that for the use case of multiple output streams, application
643     * must select one unique size from this metadata to use (e.g., preview and recording streams
644     * must have the same size). Otherwise, the high speed capture session creation will fail.</p>
645     * <p>The min and max fps will be multiple times of 30fps.</p>
646     * <p>High speed video streaming extends significant performance pressue to camera hardware,
647     * to achieve efficient high speed streaming, the camera device may have to aggregate
648     * multiple frames together and send to camera device for processing where the request
649     * controls are same for all the frames in this batch. Max batch size indicates
650     * the max possible number of frames the camera device will group together for this high
651     * speed stream configuration. This max batch size will be used to generate a high speed
652     * recording request list by
653     * {@link android.hardware.camera2.CameraDevice#createConstrainedHighSpeedRequestList }.
654     * The max batch size for each configuration will satisfy below conditions:</p>
655     * <ul>
656     * <li>Each max batch size will be a divisor of its corresponding fps_max / 30. For example,
657     * if max_fps is 300, max batch size will only be 1, 2, 5, or 10.</li>
658     * <li>The camera device may choose smaller internal batch size for each configuration, but
659     * the actual batch size will be a divisor of max batch size. For example, if the max batch
660     * size is 8, the actual batch size used by camera device will only be 1, 2, 4, or 8.</li>
661     * <li>The max batch size in each configuration entry must be no larger than 32.</li>
662     * </ul>
663     * <p>The camera device doesn't have to support batch mode to achieve high speed video recording,
664     * in such case, batch_size_max will be reported as 1 in each configuration entry.</p>
665     * <p>This fps ranges in this configuration list can only be used to create requests
666     * that are submitted to a high speed camera capture session created by
667     * {@link android.hardware.camera2.CameraDevice#createConstrainedHighSpeedCaptureSession }.
668     * The fps ranges reported in this metadata must not be used to setup capture requests for
669     * normal capture session, or it will cause request error.</p>
670     * <p><b>Range of valid values:</b><br></p>
671     * <p>For each configuration, the fps_max &gt;= 120fps.</p>
672     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
673     * <p><b>Limited capability</b> -
674     * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
675     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
676     *
677     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
678     * @hide
679     */
680    public static final Key<android.hardware.camera2.params.HighSpeedVideoConfiguration[]> CONTROL_AVAILABLE_HIGH_SPEED_VIDEO_CONFIGURATIONS =
681            new Key<android.hardware.camera2.params.HighSpeedVideoConfiguration[]>("android.control.availableHighSpeedVideoConfigurations", android.hardware.camera2.params.HighSpeedVideoConfiguration[].class);
682
683    /**
684     * <p>Whether the camera device supports {@link CaptureRequest#CONTROL_AE_LOCK android.control.aeLock}</p>
685     * <p>Devices with MANUAL_SENSOR capability or BURST_CAPTURE capability will always
686     * list <code>true</code>. This includes FULL devices.</p>
687     * <p>This key is available on all devices.</p>
688     *
689     * @see CaptureRequest#CONTROL_AE_LOCK
690     */
691    @PublicKey
692    public static final Key<Boolean> CONTROL_AE_LOCK_AVAILABLE =
693            new Key<Boolean>("android.control.aeLockAvailable", boolean.class);
694
695    /**
696     * <p>Whether the camera device supports {@link CaptureRequest#CONTROL_AWB_LOCK android.control.awbLock}</p>
697     * <p>Devices with MANUAL_POST_PROCESSING capability or BURST_CAPTURE capability will
698     * always list <code>true</code>. This includes FULL devices.</p>
699     * <p>This key is available on all devices.</p>
700     *
701     * @see CaptureRequest#CONTROL_AWB_LOCK
702     */
703    @PublicKey
704    public static final Key<Boolean> CONTROL_AWB_LOCK_AVAILABLE =
705            new Key<Boolean>("android.control.awbLockAvailable", boolean.class);
706
707    /**
708     * <p>List of control modes for {@link CaptureRequest#CONTROL_MODE android.control.mode} that are supported by this camera
709     * device.</p>
710     * <p>This list contains control modes that can be set for the camera device.
711     * LEGACY mode devices will always support AUTO mode. LIMITED and FULL
712     * devices will always support OFF, AUTO modes.</p>
713     * <p><b>Range of valid values:</b><br>
714     * Any value listed in {@link CaptureRequest#CONTROL_MODE android.control.mode}</p>
715     * <p>This key is available on all devices.</p>
716     *
717     * @see CaptureRequest#CONTROL_MODE
718     */
719    @PublicKey
720    public static final Key<int[]> CONTROL_AVAILABLE_MODES =
721            new Key<int[]>("android.control.availableModes", int[].class);
722
723    /**
724     * <p>List of edge enhancement modes for {@link CaptureRequest#EDGE_MODE android.edge.mode} that are supported by this camera
725     * device.</p>
726     * <p>Full-capability camera devices must always support OFF; all devices will list FAST.</p>
727     * <p><b>Range of valid values:</b><br>
728     * Any value listed in {@link CaptureRequest#EDGE_MODE android.edge.mode}</p>
729     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
730     * <p><b>Full capability</b> -
731     * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
732     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
733     *
734     * @see CaptureRequest#EDGE_MODE
735     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
736     */
737    @PublicKey
738    public static final Key<int[]> EDGE_AVAILABLE_EDGE_MODES =
739            new Key<int[]>("android.edge.availableEdgeModes", int[].class);
740
741    /**
742     * <p>Whether this camera device has a
743     * flash unit.</p>
744     * <p>Will be <code>false</code> if no flash is available.</p>
745     * <p>If there is no flash unit, none of the flash controls do
746     * anything.
747     * This key is available on all devices.</p>
748     */
749    @PublicKey
750    public static final Key<Boolean> FLASH_INFO_AVAILABLE =
751            new Key<Boolean>("android.flash.info.available", boolean.class);
752
753    /**
754     * <p>List of hot pixel correction modes for {@link CaptureRequest#HOT_PIXEL_MODE android.hotPixel.mode} that are supported by this
755     * camera device.</p>
756     * <p>FULL mode camera devices will always support FAST.</p>
757     * <p><b>Range of valid values:</b><br>
758     * Any value listed in {@link CaptureRequest#HOT_PIXEL_MODE android.hotPixel.mode}</p>
759     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
760     *
761     * @see CaptureRequest#HOT_PIXEL_MODE
762     */
763    @PublicKey
764    public static final Key<int[]> HOT_PIXEL_AVAILABLE_HOT_PIXEL_MODES =
765            new Key<int[]>("android.hotPixel.availableHotPixelModes", int[].class);
766
767    /**
768     * <p>List of JPEG thumbnail sizes for {@link CaptureRequest#JPEG_THUMBNAIL_SIZE android.jpeg.thumbnailSize} supported by this
769     * camera device.</p>
770     * <p>This list will include at least one non-zero resolution, plus <code>(0,0)</code> for indicating no
771     * thumbnail should be generated.</p>
772     * <p>Below condiditions will be satisfied for this size list:</p>
773     * <ul>
774     * <li>The sizes will be sorted by increasing pixel area (width x height).
775     * If several resolutions have the same area, they will be sorted by increasing width.</li>
776     * <li>The aspect ratio of the largest thumbnail size will be same as the
777     * aspect ratio of largest JPEG output size in android.scaler.availableStreamConfigurations.
778     * The largest size is defined as the size that has the largest pixel area
779     * in a given size list.</li>
780     * <li>Each output JPEG size in android.scaler.availableStreamConfigurations will have at least
781     * one corresponding size that has the same aspect ratio in availableThumbnailSizes,
782     * and vice versa.</li>
783     * <li>All non-<code>(0, 0)</code> sizes will have non-zero widths and heights.
784     * This key is available on all devices.</li>
785     * </ul>
786     *
787     * @see CaptureRequest#JPEG_THUMBNAIL_SIZE
788     */
789    @PublicKey
790    public static final Key<android.util.Size[]> JPEG_AVAILABLE_THUMBNAIL_SIZES =
791            new Key<android.util.Size[]>("android.jpeg.availableThumbnailSizes", android.util.Size[].class);
792
793    /**
794     * <p>List of aperture size values for {@link CaptureRequest#LENS_APERTURE android.lens.aperture} that are
795     * supported by this camera device.</p>
796     * <p>If the camera device doesn't support a variable lens aperture,
797     * this list will contain only one value, which is the fixed aperture size.</p>
798     * <p>If the camera device supports a variable aperture, the aperture values
799     * in this list will be sorted in ascending order.</p>
800     * <p><b>Units</b>: The aperture f-number</p>
801     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
802     * <p><b>Full capability</b> -
803     * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
804     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
805     *
806     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
807     * @see CaptureRequest#LENS_APERTURE
808     */
809    @PublicKey
810    public static final Key<float[]> LENS_INFO_AVAILABLE_APERTURES =
811            new Key<float[]>("android.lens.info.availableApertures", float[].class);
812
813    /**
814     * <p>List of neutral density filter values for
815     * {@link CaptureRequest#LENS_FILTER_DENSITY android.lens.filterDensity} that are supported by this camera device.</p>
816     * <p>If a neutral density filter is not supported by this camera device,
817     * this list will contain only 0. Otherwise, this list will include every
818     * filter density supported by the camera device, in ascending order.</p>
819     * <p><b>Units</b>: Exposure value (EV)</p>
820     * <p><b>Range of valid values:</b><br></p>
821     * <p>Values are &gt;= 0</p>
822     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
823     * <p><b>Full capability</b> -
824     * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
825     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
826     *
827     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
828     * @see CaptureRequest#LENS_FILTER_DENSITY
829     */
830    @PublicKey
831    public static final Key<float[]> LENS_INFO_AVAILABLE_FILTER_DENSITIES =
832            new Key<float[]>("android.lens.info.availableFilterDensities", float[].class);
833
834    /**
835     * <p>List of focal lengths for {@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength} that are supported by this camera
836     * device.</p>
837     * <p>If optical zoom is not supported, this list will only contain
838     * a single value corresponding to the fixed focal length of the
839     * device. Otherwise, this list will include every focal length supported
840     * by the camera device, in ascending order.</p>
841     * <p><b>Units</b>: Millimeters</p>
842     * <p><b>Range of valid values:</b><br></p>
843     * <p>Values are &gt; 0</p>
844     * <p>This key is available on all devices.</p>
845     *
846     * @see CaptureRequest#LENS_FOCAL_LENGTH
847     */
848    @PublicKey
849    public static final Key<float[]> LENS_INFO_AVAILABLE_FOCAL_LENGTHS =
850            new Key<float[]>("android.lens.info.availableFocalLengths", float[].class);
851
852    /**
853     * <p>List of optical image stabilization (OIS) modes for
854     * {@link CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE android.lens.opticalStabilizationMode} that are supported by this camera device.</p>
855     * <p>If OIS is not supported by a given camera device, this list will
856     * contain only OFF.</p>
857     * <p><b>Range of valid values:</b><br>
858     * Any value listed in {@link CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE android.lens.opticalStabilizationMode}</p>
859     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
860     * <p><b>Limited capability</b> -
861     * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
862     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
863     *
864     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
865     * @see CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE
866     */
867    @PublicKey
868    public static final Key<int[]> LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION =
869            new Key<int[]>("android.lens.info.availableOpticalStabilization", int[].class);
870
871    /**
872     * <p>Hyperfocal distance for this lens.</p>
873     * <p>If the lens is not fixed focus, the camera device will report this
874     * field when {@link CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION android.lens.info.focusDistanceCalibration} is APPROXIMATE or CALIBRATED.</p>
875     * <p><b>Units</b>: See {@link CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION android.lens.info.focusDistanceCalibration} for details</p>
876     * <p><b>Range of valid values:</b><br>
877     * If lens is fixed focus, &gt;= 0. If lens has focuser unit, the value is
878     * within <code>(0.0f, {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance}]</code></p>
879     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
880     * <p><b>Limited capability</b> -
881     * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
882     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
883     *
884     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
885     * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION
886     * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE
887     */
888    @PublicKey
889    public static final Key<Float> LENS_INFO_HYPERFOCAL_DISTANCE =
890            new Key<Float>("android.lens.info.hyperfocalDistance", float.class);
891
892    /**
893     * <p>Shortest distance from frontmost surface
894     * of the lens that can be brought into sharp focus.</p>
895     * <p>If the lens is fixed-focus, this will be
896     * 0.</p>
897     * <p><b>Units</b>: See {@link CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION android.lens.info.focusDistanceCalibration} for details</p>
898     * <p><b>Range of valid values:</b><br>
899     * &gt;= 0</p>
900     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
901     * <p><b>Limited capability</b> -
902     * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
903     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
904     *
905     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
906     * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION
907     */
908    @PublicKey
909    public static final Key<Float> LENS_INFO_MINIMUM_FOCUS_DISTANCE =
910            new Key<Float>("android.lens.info.minimumFocusDistance", float.class);
911
912    /**
913     * <p>Dimensions of lens shading map.</p>
914     * <p>The map should be on the order of 30-40 rows and columns, and
915     * must be smaller than 64x64.</p>
916     * <p><b>Range of valid values:</b><br>
917     * Both values &gt;= 1</p>
918     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
919     * <p><b>Full capability</b> -
920     * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
921     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
922     *
923     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
924     * @hide
925     */
926    public static final Key<android.util.Size> LENS_INFO_SHADING_MAP_SIZE =
927            new Key<android.util.Size>("android.lens.info.shadingMapSize", android.util.Size.class);
928
929    /**
930     * <p>The lens focus distance calibration quality.</p>
931     * <p>The lens focus distance calibration quality determines the reliability of
932     * focus related metadata entries, i.e. {@link CaptureRequest#LENS_FOCUS_DISTANCE android.lens.focusDistance},
933     * {@link CaptureResult#LENS_FOCUS_RANGE android.lens.focusRange}, {@link CameraCharacteristics#LENS_INFO_HYPERFOCAL_DISTANCE android.lens.info.hyperfocalDistance}, and
934     * {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance}.</p>
935     * <p>APPROXIMATE and CALIBRATED devices report the focus metadata in
936     * units of diopters (1/meter), so <code>0.0f</code> represents focusing at infinity,
937     * and increasing positive numbers represent focusing closer and closer
938     * to the camera device. The focus distance control also uses diopters
939     * on these devices.</p>
940     * <p>UNCALIBRATED devices do not use units that are directly comparable
941     * to any real physical measurement, but <code>0.0f</code> still represents farthest
942     * focus, and {@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} represents the
943     * nearest focus the device can achieve.</p>
944     * <p><b>Possible values:</b>
945     * <ul>
946     *   <li>{@link #LENS_INFO_FOCUS_DISTANCE_CALIBRATION_UNCALIBRATED UNCALIBRATED}</li>
947     *   <li>{@link #LENS_INFO_FOCUS_DISTANCE_CALIBRATION_APPROXIMATE APPROXIMATE}</li>
948     *   <li>{@link #LENS_INFO_FOCUS_DISTANCE_CALIBRATION_CALIBRATED CALIBRATED}</li>
949     * </ul></p>
950     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
951     * <p><b>Limited capability</b> -
952     * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
953     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
954     *
955     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
956     * @see CaptureRequest#LENS_FOCUS_DISTANCE
957     * @see CaptureResult#LENS_FOCUS_RANGE
958     * @see CameraCharacteristics#LENS_INFO_HYPERFOCAL_DISTANCE
959     * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE
960     * @see #LENS_INFO_FOCUS_DISTANCE_CALIBRATION_UNCALIBRATED
961     * @see #LENS_INFO_FOCUS_DISTANCE_CALIBRATION_APPROXIMATE
962     * @see #LENS_INFO_FOCUS_DISTANCE_CALIBRATION_CALIBRATED
963     */
964    @PublicKey
965    public static final Key<Integer> LENS_INFO_FOCUS_DISTANCE_CALIBRATION =
966            new Key<Integer>("android.lens.info.focusDistanceCalibration", int.class);
967
968    /**
969     * <p>Direction the camera faces relative to
970     * device screen.</p>
971     * <p><b>Possible values:</b>
972     * <ul>
973     *   <li>{@link #LENS_FACING_FRONT FRONT}</li>
974     *   <li>{@link #LENS_FACING_BACK BACK}</li>
975     *   <li>{@link #LENS_FACING_EXTERNAL EXTERNAL}</li>
976     * </ul></p>
977     * <p>This key is available on all devices.</p>
978     * @see #LENS_FACING_FRONT
979     * @see #LENS_FACING_BACK
980     * @see #LENS_FACING_EXTERNAL
981     */
982    @PublicKey
983    public static final Key<Integer> LENS_FACING =
984            new Key<Integer>("android.lens.facing", int.class);
985
986    /**
987     * <p>The orientation of the camera relative to the sensor
988     * coordinate system.</p>
989     * <p>The four coefficients that describe the quarternion
990     * rotation from the Android sensor coordinate system to a
991     * camera-aligned coordinate system where the X-axis is
992     * aligned with the long side of the image sensor, the Y-axis
993     * is aligned with the short side of the image sensor, and
994     * the Z-axis is aligned with the optical axis of the sensor.</p>
995     * <p>To convert from the quarternion coefficients <code>(x,y,z,w)</code>
996     * to the axis of rotation <code>(a_x, a_y, a_z)</code> and rotation
997     * amount <code>theta</code>, the following formulas can be used:</p>
998     * <pre><code> theta = 2 * acos(w)
999     * a_x = x / sin(theta/2)
1000     * a_y = y / sin(theta/2)
1001     * a_z = z / sin(theta/2)
1002     * </code></pre>
1003     * <p>To create a 3x3 rotation matrix that applies the rotation
1004     * defined by this quarternion, the following matrix can be
1005     * used:</p>
1006     * <pre><code>R = [ 1 - 2y^2 - 2z^2,       2xy - 2zw,       2xz + 2yw,
1007     *            2xy + 2zw, 1 - 2x^2 - 2z^2,       2yz - 2xw,
1008     *            2xz - 2yw,       2yz + 2xw, 1 - 2x^2 - 2y^2 ]
1009     * </code></pre>
1010     * <p>This matrix can then be used to apply the rotation to a
1011     *  column vector point with</p>
1012     * <p><code>p' = Rp</code></p>
1013     * <p>where <code>p</code> is in the device sensor coordinate system, and
1014     *  <code>p'</code> is in the camera-oriented coordinate system.</p>
1015     * <p><b>Units</b>:
1016     * Quarternion coefficients</p>
1017     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1018     */
1019    @PublicKey
1020    public static final Key<float[]> LENS_POSE_ROTATION =
1021            new Key<float[]>("android.lens.poseRotation", float[].class);
1022
1023    /**
1024     * <p>Position of the camera optical center.</p>
1025     * <p>The position of the camera device's lens optical center,
1026     * as a three-dimensional vector <code>(x,y,z)</code>, relative to the
1027     * optical center of the largest camera device facing in the
1028     * same direction as this camera, in the {@link android.hardware.SensorEvent Android sensor coordinate
1029     * axes}. Note that only the axis definitions are shared with
1030     * the sensor coordinate system, but not the origin.</p>
1031     * <p>If this device is the largest or only camera device with a
1032     * given facing, then this position will be <code>(0, 0, 0)</code>; a
1033     * camera device with a lens optical center located 3 cm from
1034     * the main sensor along the +X axis (to the right from the
1035     * user's perspective) will report <code>(0.03, 0, 0)</code>.</p>
1036     * <p>To transform a pixel coordinates between two cameras
1037     * facing the same direction, first the source camera
1038     * android.lens.radialDistortion must be corrected for.  Then
1039     * the source camera android.lens.intrinsicCalibration needs
1040     * to be applied, followed by the {@link CameraCharacteristics#LENS_POSE_ROTATION android.lens.poseRotation}
1041     * of the source camera, the translation of the source camera
1042     * relative to the destination camera, the
1043     * {@link CameraCharacteristics#LENS_POSE_ROTATION android.lens.poseRotation} of the destination camera, and
1044     * finally the inverse of android.lens.intrinsicCalibration
1045     * of the destination camera. This obtains a
1046     * radial-distortion-free coordinate in the destination
1047     * camera pixel coordinates.</p>
1048     * <p>To compare this against a real image from the destination
1049     * camera, the destination camera image then needs to be
1050     * corrected for radial distortion before comparison or
1051     * sampling.</p>
1052     * <p><b>Units</b>: Meters</p>
1053     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1054     *
1055     * @see CameraCharacteristics#LENS_POSE_ROTATION
1056     */
1057    @PublicKey
1058    public static final Key<float[]> LENS_POSE_TRANSLATION =
1059            new Key<float[]>("android.lens.poseTranslation", float[].class);
1060
1061    /**
1062     * <p>The parameters for this camera device's intrinsic
1063     * calibration.</p>
1064     * <p>The five calibration parameters that describe the
1065     * transform from camera-centric 3D coordinates to sensor
1066     * pixel coordinates:</p>
1067     * <pre><code>[f_x, f_y, c_x, c_y, s]
1068     * </code></pre>
1069     * <p>Where <code>f_x</code> and <code>f_y</code> are the horizontal and vertical
1070     * focal lengths, <code>[c_x, c_y]</code> is the position of the optical
1071     * axis, and <code>s</code> is a skew parameter for the sensor plane not
1072     * being aligned with the lens plane.</p>
1073     * <p>These are typically used within a transformation matrix K:</p>
1074     * <pre><code>K = [ f_x,   s, c_x,
1075     *        0, f_y, c_y,
1076     *        0    0,   1 ]
1077     * </code></pre>
1078     * <p>which can then be combined with the camera pose rotation
1079     * <code>R</code> and translation <code>t</code> ({@link CameraCharacteristics#LENS_POSE_ROTATION android.lens.poseRotation} and
1080     * {@link CameraCharacteristics#LENS_POSE_TRANSLATION android.lens.poseTranslation}, respective) to calculate the
1081     * complete transform from world coordinates to pixel
1082     * coordinates:</p>
1083     * <pre><code>P = [ K 0   * [ R t
1084     *      0 1 ]     0 1 ]
1085     * </code></pre>
1086     * <p>and with <code>p_w</code> being a point in the world coordinate system
1087     * and <code>p_s</code> being a point in the camera active pixel array
1088     * coordinate system, and with the mapping including the
1089     * homogeneous division by z:</p>
1090     * <pre><code> p_h = (x_h, y_h, z_h) = P p_w
1091     * p_s = p_h / z_h
1092     * </code></pre>
1093     * <p>so <code>[x_s, y_s]</code> is the pixel coordinates of the world
1094     * point, <code>z_s = 1</code>, and <code>w_s</code> is a measurement of disparity
1095     * (depth) in pixel coordinates.</p>
1096     * <p><b>Units</b>:
1097     * Pixels in the {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize} coordinate
1098     * system.</p>
1099     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1100     *
1101     * @see CameraCharacteristics#LENS_POSE_ROTATION
1102     * @see CameraCharacteristics#LENS_POSE_TRANSLATION
1103     * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
1104     */
1105    @PublicKey
1106    public static final Key<float[]> LENS_INTRINSIC_CALIBRATION =
1107            new Key<float[]>("android.lens.intrinsicCalibration", float[].class);
1108
1109    /**
1110     * <p>The correction coefficients to correct for this camera device's
1111     * radial and tangential lens distortion.</p>
1112     * <p>Four radial distortion coefficients <code>[kappa_0, kappa_1, kappa_2,
1113     * kappa_3]</code> and two tangential distortion coefficients
1114     * <code>[kappa_4, kappa_5]</code> that can be used to correct the
1115     * lens's geometric distortion with the mapping equations:</p>
1116     * <pre><code> x_c = x_i * ( kappa_0 + kappa_1 * r^2 + kappa_2 * r^4 + kappa_3 * r^6 ) +
1117     *        kappa_4 * (2 * x_i * y_i) + kappa_5 * ( r^2 + 2 * x_i^2 )
1118     *  y_c = y_i * ( kappa_0 + kappa_1 * r^2 + kappa_2 * r^4 + kappa_3 * r^6 ) +
1119     *        kappa_5 * (2 * x_i * y_i) + kappa_4 * ( r^2 + 2 * y_i^2 )
1120     * </code></pre>
1121     * <p>Here, <code>[x_c, y_c]</code> are the coordinates to sample in the
1122     * input image that correspond to the pixel values in the
1123     * corrected image at the coordinate <code>[x_i, y_i]</code>:</p>
1124     * <pre><code> correctedImage(x_i, y_i) = sample_at(x_c, y_c, inputImage)
1125     * </code></pre>
1126     * <p>The pixel coordinates are defined in a normalized
1127     * coordinate system related to the
1128     * android.lens.intrinsicCalibration calibration fields.
1129     * Both <code>[x_i, y_i]</code> and <code>[x_c, y_c]</code> have <code>(0,0)</code> at the
1130     * lens optical center <code>[c_x, c_y]</code>. The maximum magnitudes
1131     * of both x and y coordinates are normalized to be 1 at the
1132     * edge further from the optical center, so the range
1133     * for both dimensions is <code>-1 &lt;= x &lt;= 1</code>.</p>
1134     * <p>Finally, <code>r</code> represents the radial distance from the
1135     * optical center, <code>r^2 = x_i^2 + y_i^2</code>, and its magnitude
1136     * is therefore no larger than <code>|r| &lt;= sqrt(2)</code>.</p>
1137     * <p>The distortion model used is the Brown-Conrady model.</p>
1138     * <p><b>Units</b>:
1139     * Unitless coefficients.</p>
1140     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1141     */
1142    @PublicKey
1143    public static final Key<float[]> LENS_RADIAL_DISTORTION =
1144            new Key<float[]>("android.lens.radialDistortion", float[].class);
1145
1146    /**
1147     * <p>List of noise reduction modes for {@link CaptureRequest#NOISE_REDUCTION_MODE android.noiseReduction.mode} that are supported
1148     * by this camera device.</p>
1149     * <p>Full-capability camera devices will always support OFF and FAST.</p>
1150     * <p>Legacy-capability camera devices will only support FAST mode.</p>
1151     * <p><b>Range of valid values:</b><br>
1152     * Any value listed in {@link CaptureRequest#NOISE_REDUCTION_MODE android.noiseReduction.mode}</p>
1153     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1154     * <p><b>Limited capability</b> -
1155     * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
1156     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
1157     *
1158     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1159     * @see CaptureRequest#NOISE_REDUCTION_MODE
1160     */
1161    @PublicKey
1162    public static final Key<int[]> NOISE_REDUCTION_AVAILABLE_NOISE_REDUCTION_MODES =
1163            new Key<int[]>("android.noiseReduction.availableNoiseReductionModes", int[].class);
1164
1165    /**
1166     * <p>If set to 1, the HAL will always split result
1167     * metadata for a single capture into multiple buffers,
1168     * returned using multiple process_capture_result calls.</p>
1169     * <p>Does not need to be listed in static
1170     * metadata. Support for partial results will be reworked in
1171     * future versions of camera service. This quirk will stop
1172     * working at that point; DO NOT USE without careful
1173     * consideration of future support.</p>
1174     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1175     * @deprecated
1176     * @hide
1177     */
1178    @Deprecated
1179    public static final Key<Byte> QUIRKS_USE_PARTIAL_RESULT =
1180            new Key<Byte>("android.quirks.usePartialResult", byte.class);
1181
1182    /**
1183     * <p>The maximum numbers of different types of output streams
1184     * that can be configured and used simultaneously by a camera device.</p>
1185     * <p>This is a 3 element tuple that contains the max number of output simultaneous
1186     * streams for raw sensor, processed (but not stalling), and processed (and stalling)
1187     * formats respectively. For example, assuming that JPEG is typically a processed and
1188     * stalling stream, if max raw sensor format output stream number is 1, max YUV streams
1189     * number is 3, and max JPEG stream number is 2, then this tuple should be <code>(1, 3, 2)</code>.</p>
1190     * <p>This lists the upper bound of the number of output streams supported by
1191     * the camera device. Using more streams simultaneously may require more hardware and
1192     * CPU resources that will consume more power. The image format for an output stream can
1193     * be any supported format provided by android.scaler.availableStreamConfigurations.
1194     * The formats defined in android.scaler.availableStreamConfigurations can be catergorized
1195     * into the 3 stream types as below:</p>
1196     * <ul>
1197     * <li>Processed (but stalling): any non-RAW format with a stallDurations &gt; 0.
1198     *   Typically {@link android.graphics.ImageFormat#JPEG JPEG format}.</li>
1199     * <li>Raw formats: {@link android.graphics.ImageFormat#RAW_SENSOR RAW_SENSOR}, {@link android.graphics.ImageFormat#RAW10 RAW10}, or {@link android.graphics.ImageFormat#RAW12 RAW12}.</li>
1200     * <li>Processed (but not-stalling): any non-RAW format without a stall duration.
1201     *   Typically {@link android.graphics.ImageFormat#YUV_420_888 YUV_420_888},
1202     *   {@link android.graphics.ImageFormat#NV21 NV21}, or
1203     *   {@link android.graphics.ImageFormat#YV12 YV12}.</li>
1204     * </ul>
1205     * <p><b>Range of valid values:</b><br></p>
1206     * <p>For processed (and stalling) format streams, &gt;= 1.</p>
1207     * <p>For Raw format (either stalling or non-stalling) streams, &gt;= 0.</p>
1208     * <p>For processed (but not stalling) format streams, &gt;= 3
1209     * for FULL mode devices (<code>{@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} == FULL</code>);
1210     * &gt;= 2 for LIMITED mode devices (<code>{@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} == LIMITED</code>).</p>
1211     * <p>This key is available on all devices.</p>
1212     *
1213     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1214     * @hide
1215     */
1216    public static final Key<int[]> REQUEST_MAX_NUM_OUTPUT_STREAMS =
1217            new Key<int[]>("android.request.maxNumOutputStreams", int[].class);
1218
1219    /**
1220     * <p>The maximum numbers of different types of output streams
1221     * that can be configured and used simultaneously by a camera device
1222     * for any <code>RAW</code> formats.</p>
1223     * <p>This value contains the max number of output simultaneous
1224     * streams from the raw sensor.</p>
1225     * <p>This lists the upper bound of the number of output streams supported by
1226     * the camera device. Using more streams simultaneously may require more hardware and
1227     * CPU resources that will consume more power. The image format for this kind of an output stream can
1228     * be any <code>RAW</code> and supported format provided by {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap}.</p>
1229     * <p>In particular, a <code>RAW</code> format is typically one of:</p>
1230     * <ul>
1231     * <li>{@link android.graphics.ImageFormat#RAW_SENSOR RAW_SENSOR}</li>
1232     * <li>{@link android.graphics.ImageFormat#RAW10 RAW10}</li>
1233     * <li>{@link android.graphics.ImageFormat#RAW12 RAW12}</li>
1234     * </ul>
1235     * <p>LEGACY mode devices ({@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} <code>==</code> LEGACY)
1236     * never support raw streams.</p>
1237     * <p><b>Range of valid values:</b><br></p>
1238     * <p>&gt;= 0</p>
1239     * <p>This key is available on all devices.</p>
1240     *
1241     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1242     * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP
1243     */
1244    @PublicKey
1245    @SyntheticKey
1246    public static final Key<Integer> REQUEST_MAX_NUM_OUTPUT_RAW =
1247            new Key<Integer>("android.request.maxNumOutputRaw", int.class);
1248
1249    /**
1250     * <p>The maximum numbers of different types of output streams
1251     * that can be configured and used simultaneously by a camera device
1252     * for any processed (but not-stalling) formats.</p>
1253     * <p>This value contains the max number of output simultaneous
1254     * streams for any processed (but not-stalling) formats.</p>
1255     * <p>This lists the upper bound of the number of output streams supported by
1256     * the camera device. Using more streams simultaneously may require more hardware and
1257     * CPU resources that will consume more power. The image format for this kind of an output stream can
1258     * be any non-<code>RAW</code> and supported format provided by {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap}.</p>
1259     * <p>Processed (but not-stalling) is defined as any non-RAW format without a stall duration.
1260     * Typically:</p>
1261     * <ul>
1262     * <li>{@link android.graphics.ImageFormat#YUV_420_888 YUV_420_888}</li>
1263     * <li>{@link android.graphics.ImageFormat#NV21 NV21}</li>
1264     * <li>{@link android.graphics.ImageFormat#YV12 YV12}</li>
1265     * <li>Implementation-defined formats, i.e. {@link android.hardware.camera2.params.StreamConfigurationMap#isOutputSupportedFor(Class) }</li>
1266     * </ul>
1267     * <p>For full guarantees, query {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration } with a
1268     * processed format -- it will return 0 for a non-stalling stream.</p>
1269     * <p>LEGACY devices will support at least 2 processing/non-stalling streams.</p>
1270     * <p><b>Range of valid values:</b><br></p>
1271     * <p>&gt;= 3
1272     * for FULL mode devices (<code>{@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} == FULL</code>);
1273     * &gt;= 2 for LIMITED mode devices (<code>{@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} == LIMITED</code>).</p>
1274     * <p>This key is available on all devices.</p>
1275     *
1276     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1277     * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP
1278     */
1279    @PublicKey
1280    @SyntheticKey
1281    public static final Key<Integer> REQUEST_MAX_NUM_OUTPUT_PROC =
1282            new Key<Integer>("android.request.maxNumOutputProc", int.class);
1283
1284    /**
1285     * <p>The maximum numbers of different types of output streams
1286     * that can be configured and used simultaneously by a camera device
1287     * for any processed (and stalling) formats.</p>
1288     * <p>This value contains the max number of output simultaneous
1289     * streams for any processed (but not-stalling) formats.</p>
1290     * <p>This lists the upper bound of the number of output streams supported by
1291     * the camera device. Using more streams simultaneously may require more hardware and
1292     * CPU resources that will consume more power. The image format for this kind of an output stream can
1293     * be any non-<code>RAW</code> and supported format provided by {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap}.</p>
1294     * <p>A processed and stalling format is defined as any non-RAW format with a stallDurations
1295     * &gt; 0.  Typically only the {@link android.graphics.ImageFormat#JPEG JPEG format} is a
1296     * stalling format.</p>
1297     * <p>For full guarantees, query {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration } with a
1298     * processed format -- it will return a non-0 value for a stalling stream.</p>
1299     * <p>LEGACY devices will support up to 1 processing/stalling stream.</p>
1300     * <p><b>Range of valid values:</b><br></p>
1301     * <p>&gt;= 1</p>
1302     * <p>This key is available on all devices.</p>
1303     *
1304     * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP
1305     */
1306    @PublicKey
1307    @SyntheticKey
1308    public static final Key<Integer> REQUEST_MAX_NUM_OUTPUT_PROC_STALLING =
1309            new Key<Integer>("android.request.maxNumOutputProcStalling", int.class);
1310
1311    /**
1312     * <p>The maximum numbers of any type of input streams
1313     * that can be configured and used simultaneously by a camera device.</p>
1314     * <p>When set to 0, it means no input stream is supported.</p>
1315     * <p>The image format for a input stream can be any supported format returned by {@link android.hardware.camera2.params.StreamConfigurationMap#getInputFormats }. When using an
1316     * input stream, there must be at least one output stream configured to to receive the
1317     * reprocessed images.</p>
1318     * <p>When an input stream and some output streams are used in a reprocessing request,
1319     * only the input buffer will be used to produce these output stream buffers, and a
1320     * new sensor image will not be captured.</p>
1321     * <p>For example, for Zero Shutter Lag (ZSL) still capture use case, the input
1322     * stream image format will be PRIVATE, the associated output stream image format
1323     * should be JPEG.</p>
1324     * <p><b>Range of valid values:</b><br></p>
1325     * <p>0 or 1.</p>
1326     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1327     * <p><b>Full capability</b> -
1328     * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
1329     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
1330     *
1331     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1332     */
1333    @PublicKey
1334    public static final Key<Integer> REQUEST_MAX_NUM_INPUT_STREAMS =
1335            new Key<Integer>("android.request.maxNumInputStreams", int.class);
1336
1337    /**
1338     * <p>Specifies the number of maximum pipeline stages a frame
1339     * has to go through from when it's exposed to when it's available
1340     * to the framework.</p>
1341     * <p>A typical minimum value for this is 2 (one stage to expose,
1342     * one stage to readout) from the sensor. The ISP then usually adds
1343     * its own stages to do custom HW processing. Further stages may be
1344     * added by SW processing.</p>
1345     * <p>Depending on what settings are used (e.g. YUV, JPEG) and what
1346     * processing is enabled (e.g. face detection), the actual pipeline
1347     * depth (specified by {@link CaptureResult#REQUEST_PIPELINE_DEPTH android.request.pipelineDepth}) may be less than
1348     * the max pipeline depth.</p>
1349     * <p>A pipeline depth of X stages is equivalent to a pipeline latency of
1350     * X frame intervals.</p>
1351     * <p>This value will normally be 8 or less, however, for high speed capture session,
1352     * the max pipeline depth will be up to 8 x size of high speed capture request list.</p>
1353     * <p>This key is available on all devices.</p>
1354     *
1355     * @see CaptureResult#REQUEST_PIPELINE_DEPTH
1356     */
1357    @PublicKey
1358    public static final Key<Byte> REQUEST_PIPELINE_MAX_DEPTH =
1359            new Key<Byte>("android.request.pipelineMaxDepth", byte.class);
1360
1361    /**
1362     * <p>Defines how many sub-components
1363     * a result will be composed of.</p>
1364     * <p>In order to combat the pipeline latency, partial results
1365     * may be delivered to the application layer from the camera device as
1366     * soon as they are available.</p>
1367     * <p>Optional; defaults to 1. A value of 1 means that partial
1368     * results are not supported, and only the final TotalCaptureResult will
1369     * be produced by the camera device.</p>
1370     * <p>A typical use case for this might be: after requesting an
1371     * auto-focus (AF) lock the new AF state might be available 50%
1372     * of the way through the pipeline.  The camera device could
1373     * then immediately dispatch this state via a partial result to
1374     * the application, and the rest of the metadata via later
1375     * partial results.</p>
1376     * <p><b>Range of valid values:</b><br>
1377     * &gt;= 1</p>
1378     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1379     */
1380    @PublicKey
1381    public static final Key<Integer> REQUEST_PARTIAL_RESULT_COUNT =
1382            new Key<Integer>("android.request.partialResultCount", int.class);
1383
1384    /**
1385     * <p>List of capabilities that this camera device
1386     * advertises as fully supporting.</p>
1387     * <p>A capability is a contract that the camera device makes in order
1388     * to be able to satisfy one or more use cases.</p>
1389     * <p>Listing a capability guarantees that the whole set of features
1390     * required to support a common use will all be available.</p>
1391     * <p>Using a subset of the functionality provided by an unsupported
1392     * capability may be possible on a specific camera device implementation;
1393     * to do this query each of android.request.availableRequestKeys,
1394     * android.request.availableResultKeys,
1395     * android.request.availableCharacteristicsKeys.</p>
1396     * <p>The following capabilities are guaranteed to be available on
1397     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} <code>==</code> FULL devices:</p>
1398     * <ul>
1399     * <li>MANUAL_SENSOR</li>
1400     * <li>MANUAL_POST_PROCESSING</li>
1401     * </ul>
1402     * <p>Other capabilities may be available on either FULL or LIMITED
1403     * devices, but the application should query this key to be sure.</p>
1404     * <p><b>Possible values:</b>
1405     * <ul>
1406     *   <li>{@link #REQUEST_AVAILABLE_CAPABILITIES_BACKWARD_COMPATIBLE BACKWARD_COMPATIBLE}</li>
1407     *   <li>{@link #REQUEST_AVAILABLE_CAPABILITIES_MANUAL_SENSOR MANUAL_SENSOR}</li>
1408     *   <li>{@link #REQUEST_AVAILABLE_CAPABILITIES_MANUAL_POST_PROCESSING MANUAL_POST_PROCESSING}</li>
1409     *   <li>{@link #REQUEST_AVAILABLE_CAPABILITIES_RAW RAW}</li>
1410     *   <li>{@link #REQUEST_AVAILABLE_CAPABILITIES_PRIVATE_REPROCESSING PRIVATE_REPROCESSING}</li>
1411     *   <li>{@link #REQUEST_AVAILABLE_CAPABILITIES_READ_SENSOR_SETTINGS READ_SENSOR_SETTINGS}</li>
1412     *   <li>{@link #REQUEST_AVAILABLE_CAPABILITIES_BURST_CAPTURE BURST_CAPTURE}</li>
1413     *   <li>{@link #REQUEST_AVAILABLE_CAPABILITIES_YUV_REPROCESSING YUV_REPROCESSING}</li>
1414     *   <li>{@link #REQUEST_AVAILABLE_CAPABILITIES_DEPTH_OUTPUT DEPTH_OUTPUT}</li>
1415     *   <li>{@link #REQUEST_AVAILABLE_CAPABILITIES_CONSTRAINED_HIGH_SPEED_VIDEO CONSTRAINED_HIGH_SPEED_VIDEO}</li>
1416     * </ul></p>
1417     * <p>This key is available on all devices.</p>
1418     *
1419     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1420     * @see #REQUEST_AVAILABLE_CAPABILITIES_BACKWARD_COMPATIBLE
1421     * @see #REQUEST_AVAILABLE_CAPABILITIES_MANUAL_SENSOR
1422     * @see #REQUEST_AVAILABLE_CAPABILITIES_MANUAL_POST_PROCESSING
1423     * @see #REQUEST_AVAILABLE_CAPABILITIES_RAW
1424     * @see #REQUEST_AVAILABLE_CAPABILITIES_PRIVATE_REPROCESSING
1425     * @see #REQUEST_AVAILABLE_CAPABILITIES_READ_SENSOR_SETTINGS
1426     * @see #REQUEST_AVAILABLE_CAPABILITIES_BURST_CAPTURE
1427     * @see #REQUEST_AVAILABLE_CAPABILITIES_YUV_REPROCESSING
1428     * @see #REQUEST_AVAILABLE_CAPABILITIES_DEPTH_OUTPUT
1429     * @see #REQUEST_AVAILABLE_CAPABILITIES_CONSTRAINED_HIGH_SPEED_VIDEO
1430     */
1431    @PublicKey
1432    public static final Key<int[]> REQUEST_AVAILABLE_CAPABILITIES =
1433            new Key<int[]>("android.request.availableCapabilities", int[].class);
1434
1435    /**
1436     * <p>A list of all keys that the camera device has available
1437     * to use with {@link android.hardware.camera2.CaptureRequest }.</p>
1438     * <p>Attempting to set a key into a CaptureRequest that is not
1439     * listed here will result in an invalid request and will be rejected
1440     * by the camera device.</p>
1441     * <p>This field can be used to query the feature set of a camera device
1442     * at a more granular level than capabilities. This is especially
1443     * important for optional keys that are not listed under any capability
1444     * in {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities}.</p>
1445     * <p>This key is available on all devices.</p>
1446     *
1447     * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
1448     * @hide
1449     */
1450    public static final Key<int[]> REQUEST_AVAILABLE_REQUEST_KEYS =
1451            new Key<int[]>("android.request.availableRequestKeys", int[].class);
1452
1453    /**
1454     * <p>A list of all keys that the camera device has available
1455     * to use with {@link android.hardware.camera2.CaptureResult }.</p>
1456     * <p>Attempting to get a key from a CaptureResult that is not
1457     * listed here will always return a <code>null</code> value. Getting a key from
1458     * a CaptureResult that is listed here will generally never return a <code>null</code>
1459     * value.</p>
1460     * <p>The following keys may return <code>null</code> unless they are enabled:</p>
1461     * <ul>
1462     * <li>android.statistics.lensShadingMap (non-null iff {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} == ON)</li>
1463     * </ul>
1464     * <p>(Those sometimes-null keys will nevertheless be listed here
1465     * if they are available.)</p>
1466     * <p>This field can be used to query the feature set of a camera device
1467     * at a more granular level than capabilities. This is especially
1468     * important for optional keys that are not listed under any capability
1469     * in {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities}.</p>
1470     * <p>This key is available on all devices.</p>
1471     *
1472     * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
1473     * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE
1474     * @hide
1475     */
1476    public static final Key<int[]> REQUEST_AVAILABLE_RESULT_KEYS =
1477            new Key<int[]>("android.request.availableResultKeys", int[].class);
1478
1479    /**
1480     * <p>A list of all keys that the camera device has available
1481     * to use with {@link android.hardware.camera2.CameraCharacteristics }.</p>
1482     * <p>This entry follows the same rules as
1483     * android.request.availableResultKeys (except that it applies for
1484     * CameraCharacteristics instead of CaptureResult). See above for more
1485     * details.</p>
1486     * <p>This key is available on all devices.</p>
1487     * @hide
1488     */
1489    public static final Key<int[]> REQUEST_AVAILABLE_CHARACTERISTICS_KEYS =
1490            new Key<int[]>("android.request.availableCharacteristicsKeys", int[].class);
1491
1492    /**
1493     * <p>The list of image formats that are supported by this
1494     * camera device for output streams.</p>
1495     * <p>All camera devices will support JPEG and YUV_420_888 formats.</p>
1496     * <p>When set to YUV_420_888, application can access the YUV420 data directly.</p>
1497     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1498     * @deprecated
1499     * @hide
1500     */
1501    @Deprecated
1502    public static final Key<int[]> SCALER_AVAILABLE_FORMATS =
1503            new Key<int[]>("android.scaler.availableFormats", int[].class);
1504
1505    /**
1506     * <p>The minimum frame duration that is supported
1507     * for each resolution in android.scaler.availableJpegSizes.</p>
1508     * <p>This corresponds to the minimum steady-state frame duration when only
1509     * that JPEG stream is active and captured in a burst, with all
1510     * processing (typically in android.*.mode) set to FAST.</p>
1511     * <p>When multiple streams are configured, the minimum
1512     * frame duration will be &gt;= max(individual stream min
1513     * durations)</p>
1514     * <p><b>Units</b>: Nanoseconds</p>
1515     * <p><b>Range of valid values:</b><br>
1516     * TODO: Remove property.</p>
1517     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1518     * @deprecated
1519     * @hide
1520     */
1521    @Deprecated
1522    public static final Key<long[]> SCALER_AVAILABLE_JPEG_MIN_DURATIONS =
1523            new Key<long[]>("android.scaler.availableJpegMinDurations", long[].class);
1524
1525    /**
1526     * <p>The JPEG resolutions that are supported by this camera device.</p>
1527     * <p>The resolutions are listed as <code>(width, height)</code> pairs. All camera devices will support
1528     * sensor maximum resolution (defined by {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}).</p>
1529     * <p><b>Range of valid values:</b><br>
1530     * TODO: Remove property.</p>
1531     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1532     *
1533     * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
1534     * @deprecated
1535     * @hide
1536     */
1537    @Deprecated
1538    public static final Key<android.util.Size[]> SCALER_AVAILABLE_JPEG_SIZES =
1539            new Key<android.util.Size[]>("android.scaler.availableJpegSizes", android.util.Size[].class);
1540
1541    /**
1542     * <p>The maximum ratio between both active area width
1543     * and crop region width, and active area height and
1544     * crop region height, for {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}.</p>
1545     * <p>This represents the maximum amount of zooming possible by
1546     * the camera device, or equivalently, the minimum cropping
1547     * window size.</p>
1548     * <p>Crop regions that have a width or height that is smaller
1549     * than this ratio allows will be rounded up to the minimum
1550     * allowed size by the camera device.</p>
1551     * <p><b>Units</b>: Zoom scale factor</p>
1552     * <p><b>Range of valid values:</b><br>
1553     * &gt;=1</p>
1554     * <p>This key is available on all devices.</p>
1555     *
1556     * @see CaptureRequest#SCALER_CROP_REGION
1557     */
1558    @PublicKey
1559    public static final Key<Float> SCALER_AVAILABLE_MAX_DIGITAL_ZOOM =
1560            new Key<Float>("android.scaler.availableMaxDigitalZoom", float.class);
1561
1562    /**
1563     * <p>For each available processed output size (defined in
1564     * android.scaler.availableProcessedSizes), this property lists the
1565     * minimum supportable frame duration for that size.</p>
1566     * <p>This should correspond to the frame duration when only that processed
1567     * stream is active, with all processing (typically in android.*.mode)
1568     * set to FAST.</p>
1569     * <p>When multiple streams are configured, the minimum frame duration will
1570     * be &gt;= max(individual stream min durations).</p>
1571     * <p><b>Units</b>: Nanoseconds</p>
1572     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1573     * @deprecated
1574     * @hide
1575     */
1576    @Deprecated
1577    public static final Key<long[]> SCALER_AVAILABLE_PROCESSED_MIN_DURATIONS =
1578            new Key<long[]>("android.scaler.availableProcessedMinDurations", long[].class);
1579
1580    /**
1581     * <p>The resolutions available for use with
1582     * processed output streams, such as YV12, NV12, and
1583     * platform opaque YUV/RGB streams to the GPU or video
1584     * encoders.</p>
1585     * <p>The resolutions are listed as <code>(width, height)</code> pairs.</p>
1586     * <p>For a given use case, the actual maximum supported resolution
1587     * may be lower than what is listed here, depending on the destination
1588     * Surface for the image data. For example, for recording video,
1589     * the video encoder chosen may have a maximum size limit (e.g. 1080p)
1590     * smaller than what the camera (e.g. maximum resolution is 3264x2448)
1591     * can provide.</p>
1592     * <p>Please reference the documentation for the image data destination to
1593     * check if it limits the maximum size for image data.</p>
1594     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1595     * @deprecated
1596     * @hide
1597     */
1598    @Deprecated
1599    public static final Key<android.util.Size[]> SCALER_AVAILABLE_PROCESSED_SIZES =
1600            new Key<android.util.Size[]>("android.scaler.availableProcessedSizes", android.util.Size[].class);
1601
1602    /**
1603     * <p>The mapping of image formats that are supported by this
1604     * camera device for input streams, to their corresponding output formats.</p>
1605     * <p>All camera devices with at least 1
1606     * {@link CameraCharacteristics#REQUEST_MAX_NUM_INPUT_STREAMS android.request.maxNumInputStreams} will have at least one
1607     * available input format.</p>
1608     * <p>The camera device will support the following map of formats,
1609     * if its dependent capability ({@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities}) is supported:</p>
1610     * <table>
1611     * <thead>
1612     * <tr>
1613     * <th align="left">Input Format</th>
1614     * <th align="left">Output Format</th>
1615     * <th align="left">Capability</th>
1616     * </tr>
1617     * </thead>
1618     * <tbody>
1619     * <tr>
1620     * <td align="left">{@link android.graphics.ImageFormat#PRIVATE }</td>
1621     * <td align="left">{@link android.graphics.ImageFormat#JPEG }</td>
1622     * <td align="left">PRIVATE_REPROCESSING</td>
1623     * </tr>
1624     * <tr>
1625     * <td align="left">{@link android.graphics.ImageFormat#PRIVATE }</td>
1626     * <td align="left">{@link android.graphics.ImageFormat#YUV_420_888 }</td>
1627     * <td align="left">PRIVATE_REPROCESSING</td>
1628     * </tr>
1629     * <tr>
1630     * <td align="left">{@link android.graphics.ImageFormat#YUV_420_888 }</td>
1631     * <td align="left">{@link android.graphics.ImageFormat#JPEG }</td>
1632     * <td align="left">YUV_REPROCESSING</td>
1633     * </tr>
1634     * <tr>
1635     * <td align="left">{@link android.graphics.ImageFormat#YUV_420_888 }</td>
1636     * <td align="left">{@link android.graphics.ImageFormat#YUV_420_888 }</td>
1637     * <td align="left">YUV_REPROCESSING</td>
1638     * </tr>
1639     * </tbody>
1640     * </table>
1641     * <p>PRIVATE refers to a device-internal format that is not directly application-visible.  A
1642     * PRIVATE input surface can be acquired by {@link android.media.ImageReader#newInstance }
1643     * with {@link android.graphics.ImageFormat#PRIVATE } as the format.</p>
1644     * <p>For a PRIVATE_REPROCESSING-capable camera device, using the PRIVATE format as either input
1645     * or output will never hurt maximum frame rate (i.e.  {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration getOutputStallDuration(ImageFormat.PRIVATE, size)} is always 0),</p>
1646     * <p>Attempting to configure an input stream with output streams not
1647     * listed as available in this map is not valid.</p>
1648     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1649     *
1650     * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
1651     * @see CameraCharacteristics#REQUEST_MAX_NUM_INPUT_STREAMS
1652     * @hide
1653     */
1654    public static final Key<android.hardware.camera2.params.ReprocessFormatsMap> SCALER_AVAILABLE_INPUT_OUTPUT_FORMATS_MAP =
1655            new Key<android.hardware.camera2.params.ReprocessFormatsMap>("android.scaler.availableInputOutputFormatsMap", android.hardware.camera2.params.ReprocessFormatsMap.class);
1656
1657    /**
1658     * <p>The available stream configurations that this
1659     * camera device supports
1660     * (i.e. format, width, height, output/input stream).</p>
1661     * <p>The configurations are listed as <code>(format, width, height, input?)</code>
1662     * tuples.</p>
1663     * <p>For a given use case, the actual maximum supported resolution
1664     * may be lower than what is listed here, depending on the destination
1665     * Surface for the image data. For example, for recording video,
1666     * the video encoder chosen may have a maximum size limit (e.g. 1080p)
1667     * smaller than what the camera (e.g. maximum resolution is 3264x2448)
1668     * can provide.</p>
1669     * <p>Please reference the documentation for the image data destination to
1670     * check if it limits the maximum size for image data.</p>
1671     * <p>Not all output formats may be supported in a configuration with
1672     * an input stream of a particular format. For more details, see
1673     * android.scaler.availableInputOutputFormatsMap.</p>
1674     * <p>The following table describes the minimum required output stream
1675     * configurations based on the hardware level
1676     * ({@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel}):</p>
1677     * <table>
1678     * <thead>
1679     * <tr>
1680     * <th align="center">Format</th>
1681     * <th align="center">Size</th>
1682     * <th align="center">Hardware Level</th>
1683     * <th align="center">Notes</th>
1684     * </tr>
1685     * </thead>
1686     * <tbody>
1687     * <tr>
1688     * <td align="center">JPEG</td>
1689     * <td align="center">{@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</td>
1690     * <td align="center">Any</td>
1691     * <td align="center"></td>
1692     * </tr>
1693     * <tr>
1694     * <td align="center">JPEG</td>
1695     * <td align="center">1920x1080 (1080p)</td>
1696     * <td align="center">Any</td>
1697     * <td align="center">if 1080p &lt;= activeArraySize</td>
1698     * </tr>
1699     * <tr>
1700     * <td align="center">JPEG</td>
1701     * <td align="center">1280x720 (720)</td>
1702     * <td align="center">Any</td>
1703     * <td align="center">if 720p &lt;= activeArraySize</td>
1704     * </tr>
1705     * <tr>
1706     * <td align="center">JPEG</td>
1707     * <td align="center">640x480 (480p)</td>
1708     * <td align="center">Any</td>
1709     * <td align="center">if 480p &lt;= activeArraySize</td>
1710     * </tr>
1711     * <tr>
1712     * <td align="center">JPEG</td>
1713     * <td align="center">320x240 (240p)</td>
1714     * <td align="center">Any</td>
1715     * <td align="center">if 240p &lt;= activeArraySize</td>
1716     * </tr>
1717     * <tr>
1718     * <td align="center">YUV_420_888</td>
1719     * <td align="center">all output sizes available for JPEG</td>
1720     * <td align="center">FULL</td>
1721     * <td align="center"></td>
1722     * </tr>
1723     * <tr>
1724     * <td align="center">YUV_420_888</td>
1725     * <td align="center">all output sizes available for JPEG, up to the maximum video size</td>
1726     * <td align="center">LIMITED</td>
1727     * <td align="center"></td>
1728     * </tr>
1729     * <tr>
1730     * <td align="center">IMPLEMENTATION_DEFINED</td>
1731     * <td align="center">same as YUV_420_888</td>
1732     * <td align="center">Any</td>
1733     * <td align="center"></td>
1734     * </tr>
1735     * </tbody>
1736     * </table>
1737     * <p>Refer to {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} for additional
1738     * mandatory stream configurations on a per-capability basis.</p>
1739     * <p>This key is available on all devices.</p>
1740     *
1741     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1742     * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
1743     * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
1744     * @hide
1745     */
1746    public static final Key<android.hardware.camera2.params.StreamConfiguration[]> SCALER_AVAILABLE_STREAM_CONFIGURATIONS =
1747            new Key<android.hardware.camera2.params.StreamConfiguration[]>("android.scaler.availableStreamConfigurations", android.hardware.camera2.params.StreamConfiguration[].class);
1748
1749    /**
1750     * <p>This lists the minimum frame duration for each
1751     * format/size combination.</p>
1752     * <p>This should correspond to the frame duration when only that
1753     * stream is active, with all processing (typically in android.*.mode)
1754     * set to either OFF or FAST.</p>
1755     * <p>When multiple streams are used in a request, the minimum frame
1756     * duration will be max(individual stream min durations).</p>
1757     * <p>The minimum frame duration of a stream (of a particular format, size)
1758     * is the same regardless of whether the stream is input or output.</p>
1759     * <p>See {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} and
1760     * android.scaler.availableStallDurations for more details about
1761     * calculating the max frame rate.</p>
1762     * <p>(Keep in sync with
1763     * {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputMinFrameDuration })</p>
1764     * <p><b>Units</b>: (format, width, height, ns) x n</p>
1765     * <p>This key is available on all devices.</p>
1766     *
1767     * @see CaptureRequest#SENSOR_FRAME_DURATION
1768     * @hide
1769     */
1770    public static final Key<android.hardware.camera2.params.StreamConfigurationDuration[]> SCALER_AVAILABLE_MIN_FRAME_DURATIONS =
1771            new Key<android.hardware.camera2.params.StreamConfigurationDuration[]>("android.scaler.availableMinFrameDurations", android.hardware.camera2.params.StreamConfigurationDuration[].class);
1772
1773    /**
1774     * <p>This lists the maximum stall duration for each
1775     * output format/size combination.</p>
1776     * <p>A stall duration is how much extra time would get added
1777     * to the normal minimum frame duration for a repeating request
1778     * that has streams with non-zero stall.</p>
1779     * <p>For example, consider JPEG captures which have the following
1780     * characteristics:</p>
1781     * <ul>
1782     * <li>JPEG streams act like processed YUV streams in requests for which
1783     * they are not included; in requests in which they are directly
1784     * referenced, they act as JPEG streams. This is because supporting a
1785     * JPEG stream requires the underlying YUV data to always be ready for
1786     * use by a JPEG encoder, but the encoder will only be used (and impact
1787     * frame duration) on requests that actually reference a JPEG stream.</li>
1788     * <li>The JPEG processor can run concurrently to the rest of the camera
1789     * pipeline, but cannot process more than 1 capture at a time.</li>
1790     * </ul>
1791     * <p>In other words, using a repeating YUV request would result
1792     * in a steady frame rate (let's say it's 30 FPS). If a single
1793     * JPEG request is submitted periodically, the frame rate will stay
1794     * at 30 FPS (as long as we wait for the previous JPEG to return each
1795     * time). If we try to submit a repeating YUV + JPEG request, then
1796     * the frame rate will drop from 30 FPS.</p>
1797     * <p>In general, submitting a new request with a non-0 stall time
1798     * stream will <em>not</em> cause a frame rate drop unless there are still
1799     * outstanding buffers for that stream from previous requests.</p>
1800     * <p>Submitting a repeating request with streams (call this <code>S</code>)
1801     * is the same as setting the minimum frame duration from
1802     * the normal minimum frame duration corresponding to <code>S</code>, added with
1803     * the maximum stall duration for <code>S</code>.</p>
1804     * <p>If interleaving requests with and without a stall duration,
1805     * a request will stall by the maximum of the remaining times
1806     * for each can-stall stream with outstanding buffers.</p>
1807     * <p>This means that a stalling request will not have an exposure start
1808     * until the stall has completed.</p>
1809     * <p>This should correspond to the stall duration when only that stream is
1810     * active, with all processing (typically in android.*.mode) set to FAST
1811     * or OFF. Setting any of the processing modes to HIGH_QUALITY
1812     * effectively results in an indeterminate stall duration for all
1813     * streams in a request (the regular stall calculation rules are
1814     * ignored).</p>
1815     * <p>The following formats may always have a stall duration:</p>
1816     * <ul>
1817     * <li>{@link android.graphics.ImageFormat#JPEG }</li>
1818     * <li>{@link android.graphics.ImageFormat#RAW_SENSOR }</li>
1819     * </ul>
1820     * <p>The following formats will never have a stall duration:</p>
1821     * <ul>
1822     * <li>{@link android.graphics.ImageFormat#YUV_420_888 }</li>
1823     * <li>{@link android.graphics.ImageFormat#RAW10 }</li>
1824     * </ul>
1825     * <p>All other formats may or may not have an allowed stall duration on
1826     * a per-capability basis; refer to {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities}
1827     * for more details.</p>
1828     * <p>See {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} for more information about
1829     * calculating the max frame rate (absent stalls).</p>
1830     * <p>(Keep up to date with
1831     * {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputStallDuration } )</p>
1832     * <p><b>Units</b>: (format, width, height, ns) x n</p>
1833     * <p>This key is available on all devices.</p>
1834     *
1835     * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
1836     * @see CaptureRequest#SENSOR_FRAME_DURATION
1837     * @hide
1838     */
1839    public static final Key<android.hardware.camera2.params.StreamConfigurationDuration[]> SCALER_AVAILABLE_STALL_DURATIONS =
1840            new Key<android.hardware.camera2.params.StreamConfigurationDuration[]>("android.scaler.availableStallDurations", android.hardware.camera2.params.StreamConfigurationDuration[].class);
1841
1842    /**
1843     * <p>The available stream configurations that this
1844     * camera device supports; also includes the minimum frame durations
1845     * and the stall durations for each format/size combination.</p>
1846     * <p>All camera devices will support sensor maximum resolution (defined by
1847     * {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}) for the JPEG format.</p>
1848     * <p>For a given use case, the actual maximum supported resolution
1849     * may be lower than what is listed here, depending on the destination
1850     * Surface for the image data. For example, for recording video,
1851     * the video encoder chosen may have a maximum size limit (e.g. 1080p)
1852     * smaller than what the camera (e.g. maximum resolution is 3264x2448)
1853     * can provide.</p>
1854     * <p>Please reference the documentation for the image data destination to
1855     * check if it limits the maximum size for image data.</p>
1856     * <p>The following table describes the minimum required output stream
1857     * configurations based on the hardware level
1858     * ({@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel}):</p>
1859     * <table>
1860     * <thead>
1861     * <tr>
1862     * <th align="center">Format</th>
1863     * <th align="center">Size</th>
1864     * <th align="center">Hardware Level</th>
1865     * <th align="center">Notes</th>
1866     * </tr>
1867     * </thead>
1868     * <tbody>
1869     * <tr>
1870     * <td align="center">{@link android.graphics.ImageFormat#JPEG }</td>
1871     * <td align="center">{@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}</td>
1872     * <td align="center">Any</td>
1873     * <td align="center"></td>
1874     * </tr>
1875     * <tr>
1876     * <td align="center">{@link android.graphics.ImageFormat#JPEG }</td>
1877     * <td align="center">1920x1080 (1080p)</td>
1878     * <td align="center">Any</td>
1879     * <td align="center">if 1080p &lt;= activeArraySize</td>
1880     * </tr>
1881     * <tr>
1882     * <td align="center">{@link android.graphics.ImageFormat#JPEG }</td>
1883     * <td align="center">1280x720 (720)</td>
1884     * <td align="center">Any</td>
1885     * <td align="center">if 720p &lt;= activeArraySize</td>
1886     * </tr>
1887     * <tr>
1888     * <td align="center">{@link android.graphics.ImageFormat#JPEG }</td>
1889     * <td align="center">640x480 (480p)</td>
1890     * <td align="center">Any</td>
1891     * <td align="center">if 480p &lt;= activeArraySize</td>
1892     * </tr>
1893     * <tr>
1894     * <td align="center">{@link android.graphics.ImageFormat#JPEG }</td>
1895     * <td align="center">320x240 (240p)</td>
1896     * <td align="center">Any</td>
1897     * <td align="center">if 240p &lt;= activeArraySize</td>
1898     * </tr>
1899     * <tr>
1900     * <td align="center">{@link android.graphics.ImageFormat#YUV_420_888 }</td>
1901     * <td align="center">all output sizes available for JPEG</td>
1902     * <td align="center">FULL</td>
1903     * <td align="center"></td>
1904     * </tr>
1905     * <tr>
1906     * <td align="center">{@link android.graphics.ImageFormat#YUV_420_888 }</td>
1907     * <td align="center">all output sizes available for JPEG, up to the maximum video size</td>
1908     * <td align="center">LIMITED</td>
1909     * <td align="center"></td>
1910     * </tr>
1911     * <tr>
1912     * <td align="center">{@link android.graphics.ImageFormat#PRIVATE }</td>
1913     * <td align="center">same as YUV_420_888</td>
1914     * <td align="center">Any</td>
1915     * <td align="center"></td>
1916     * </tr>
1917     * </tbody>
1918     * </table>
1919     * <p>Refer to {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} and {@link android.hardware.camera2.CameraDevice#createCaptureSession } for additional mandatory
1920     * stream configurations on a per-capability basis.</p>
1921     * <p>This key is available on all devices.</p>
1922     *
1923     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1924     * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
1925     * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
1926     */
1927    @PublicKey
1928    @SyntheticKey
1929    public static final Key<android.hardware.camera2.params.StreamConfigurationMap> SCALER_STREAM_CONFIGURATION_MAP =
1930            new Key<android.hardware.camera2.params.StreamConfigurationMap>("android.scaler.streamConfigurationMap", android.hardware.camera2.params.StreamConfigurationMap.class);
1931
1932    /**
1933     * <p>The crop type that this camera device supports.</p>
1934     * <p>When passing a non-centered crop region ({@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}) to a camera
1935     * device that only supports CENTER_ONLY cropping, the camera device will move the
1936     * crop region to the center of the sensor active array ({@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize})
1937     * and keep the crop region width and height unchanged. The camera device will return the
1938     * final used crop region in metadata result {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}.</p>
1939     * <p>Camera devices that support FREEFORM cropping will support any crop region that
1940     * is inside of the active array. The camera device will apply the same crop region and
1941     * return the final used crop region in capture result metadata {@link CaptureRequest#SCALER_CROP_REGION android.scaler.cropRegion}.</p>
1942     * <p>FULL capability devices ({@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} <code>==</code> FULL) will support
1943     * FREEFORM cropping. LEGACY capability devices will only support CENTER_ONLY cropping.</p>
1944     * <p><b>Possible values:</b>
1945     * <ul>
1946     *   <li>{@link #SCALER_CROPPING_TYPE_CENTER_ONLY CENTER_ONLY}</li>
1947     *   <li>{@link #SCALER_CROPPING_TYPE_FREEFORM FREEFORM}</li>
1948     * </ul></p>
1949     * <p>This key is available on all devices.</p>
1950     *
1951     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1952     * @see CaptureRequest#SCALER_CROP_REGION
1953     * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
1954     * @see #SCALER_CROPPING_TYPE_CENTER_ONLY
1955     * @see #SCALER_CROPPING_TYPE_FREEFORM
1956     */
1957    @PublicKey
1958    public static final Key<Integer> SCALER_CROPPING_TYPE =
1959            new Key<Integer>("android.scaler.croppingType", int.class);
1960
1961    /**
1962     * <p>The area of the image sensor which corresponds to
1963     * active pixels.</p>
1964     * <p>This is the region of the sensor that actually receives light from the scene.
1965     * Therefore, the size of this region determines the maximum field of view and the maximum
1966     * number of pixels that an image from this sensor can contain.</p>
1967     * <p>The rectangle is defined in terms of the full pixel array; (0,0) is the top-left of the
1968     * full pixel array, and the size of the full pixel array is given by
1969     * {@link CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE android.sensor.info.pixelArraySize}.</p>
1970     * <p>Most other keys listing pixel coordinates have their coordinate systems based on the
1971     * active array, with <code>(0, 0)</code> being the top-left of the active array rectangle.</p>
1972     * <p>The active array may be smaller than the full pixel array, since the full array may
1973     * include black calibration pixels or other inactive regions.</p>
1974     * <p><b>Units</b>: Pixel coordinates on the image sensor</p>
1975     * <p><b>Range of valid values:</b><br></p>
1976     * <p>This key is available on all devices.</p>
1977     *
1978     * @see CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE
1979     */
1980    @PublicKey
1981    public static final Key<android.graphics.Rect> SENSOR_INFO_ACTIVE_ARRAY_SIZE =
1982            new Key<android.graphics.Rect>("android.sensor.info.activeArraySize", android.graphics.Rect.class);
1983
1984    /**
1985     * <p>Range of sensitivities for {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity} supported by this
1986     * camera device.</p>
1987     * <p>The values are the standard ISO sensitivity values,
1988     * as defined in ISO 12232:2006.</p>
1989     * <p><b>Range of valid values:</b><br>
1990     * Min &lt;= 100, Max &gt;= 800</p>
1991     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
1992     * <p><b>Full capability</b> -
1993     * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
1994     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
1995     *
1996     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
1997     * @see CaptureRequest#SENSOR_SENSITIVITY
1998     */
1999    @PublicKey
2000    public static final Key<android.util.Range<Integer>> SENSOR_INFO_SENSITIVITY_RANGE =
2001            new Key<android.util.Range<Integer>>("android.sensor.info.sensitivityRange", new TypeReference<android.util.Range<Integer>>() {{ }});
2002
2003    /**
2004     * <p>The arrangement of color filters on sensor;
2005     * represents the colors in the top-left 2x2 section of
2006     * the sensor, in reading order.</p>
2007     * <p><b>Possible values:</b>
2008     * <ul>
2009     *   <li>{@link #SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGGB RGGB}</li>
2010     *   <li>{@link #SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GRBG GRBG}</li>
2011     *   <li>{@link #SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GBRG GBRG}</li>
2012     *   <li>{@link #SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_BGGR BGGR}</li>
2013     *   <li>{@link #SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGB RGB}</li>
2014     * </ul></p>
2015     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2016     * <p><b>Full capability</b> -
2017     * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
2018     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2019     *
2020     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2021     * @see #SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGGB
2022     * @see #SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GRBG
2023     * @see #SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_GBRG
2024     * @see #SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_BGGR
2025     * @see #SENSOR_INFO_COLOR_FILTER_ARRANGEMENT_RGB
2026     */
2027    @PublicKey
2028    public static final Key<Integer> SENSOR_INFO_COLOR_FILTER_ARRANGEMENT =
2029            new Key<Integer>("android.sensor.info.colorFilterArrangement", int.class);
2030
2031    /**
2032     * <p>The range of image exposure times for {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime} supported
2033     * by this camera device.</p>
2034     * <p><b>Units</b>: Nanoseconds</p>
2035     * <p><b>Range of valid values:</b><br>
2036     * The minimum exposure time will be less than 100 us. For FULL
2037     * capability devices ({@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} == FULL),
2038     * the maximum exposure time will be greater than 100ms.</p>
2039     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2040     * <p><b>Full capability</b> -
2041     * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
2042     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2043     *
2044     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2045     * @see CaptureRequest#SENSOR_EXPOSURE_TIME
2046     */
2047    @PublicKey
2048    public static final Key<android.util.Range<Long>> SENSOR_INFO_EXPOSURE_TIME_RANGE =
2049            new Key<android.util.Range<Long>>("android.sensor.info.exposureTimeRange", new TypeReference<android.util.Range<Long>>() {{ }});
2050
2051    /**
2052     * <p>The maximum possible frame duration (minimum frame rate) for
2053     * {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} that is supported this camera device.</p>
2054     * <p>Attempting to use frame durations beyond the maximum will result in the frame
2055     * duration being clipped to the maximum. See that control for a full definition of frame
2056     * durations.</p>
2057     * <p>Refer to {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputMinFrameDuration }
2058     * for the minimum frame duration values.</p>
2059     * <p><b>Units</b>: Nanoseconds</p>
2060     * <p><b>Range of valid values:</b><br>
2061     * For FULL capability devices
2062     * ({@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} == FULL), at least 100ms.</p>
2063     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2064     * <p><b>Full capability</b> -
2065     * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
2066     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2067     *
2068     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2069     * @see CaptureRequest#SENSOR_FRAME_DURATION
2070     */
2071    @PublicKey
2072    public static final Key<Long> SENSOR_INFO_MAX_FRAME_DURATION =
2073            new Key<Long>("android.sensor.info.maxFrameDuration", long.class);
2074
2075    /**
2076     * <p>The physical dimensions of the full pixel
2077     * array.</p>
2078     * <p>This is the physical size of the sensor pixel
2079     * array defined by {@link CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE android.sensor.info.pixelArraySize}.</p>
2080     * <p><b>Units</b>: Millimeters</p>
2081     * <p>This key is available on all devices.</p>
2082     *
2083     * @see CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE
2084     */
2085    @PublicKey
2086    public static final Key<android.util.SizeF> SENSOR_INFO_PHYSICAL_SIZE =
2087            new Key<android.util.SizeF>("android.sensor.info.physicalSize", android.util.SizeF.class);
2088
2089    /**
2090     * <p>Dimensions of the full pixel array, possibly
2091     * including black calibration pixels.</p>
2092     * <p>The pixel count of the full pixel array,
2093     * which covers {@link CameraCharacteristics#SENSOR_INFO_PHYSICAL_SIZE android.sensor.info.physicalSize} area.</p>
2094     * <p>If a camera device supports raw sensor formats, either this
2095     * or {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize} is the maximum output
2096     * raw size listed in {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap}.
2097     * If a size corresponding to pixelArraySize is listed, the resulting
2098     * raw sensor image will include black pixels.</p>
2099     * <p>Some parts of the full pixel array may not receive light from the scene,
2100     * or are otherwise inactive.  The {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize} key
2101     * defines the rectangle of active pixels that actually forms an image.</p>
2102     * <p><b>Units</b>: Pixels</p>
2103     * <p>This key is available on all devices.</p>
2104     *
2105     * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP
2106     * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
2107     * @see CameraCharacteristics#SENSOR_INFO_PHYSICAL_SIZE
2108     */
2109    @PublicKey
2110    public static final Key<android.util.Size> SENSOR_INFO_PIXEL_ARRAY_SIZE =
2111            new Key<android.util.Size>("android.sensor.info.pixelArraySize", android.util.Size.class);
2112
2113    /**
2114     * <p>Maximum raw value output by sensor.</p>
2115     * <p>This specifies the fully-saturated encoding level for the raw
2116     * sample values from the sensor.  This is typically caused by the
2117     * sensor becoming highly non-linear or clipping. The minimum for
2118     * each channel is specified by the offset in the
2119     * {@link CameraCharacteristics#SENSOR_BLACK_LEVEL_PATTERN android.sensor.blackLevelPattern} key.</p>
2120     * <p>The white level is typically determined either by sensor bit depth
2121     * (8-14 bits is expected), or by the point where the sensor response
2122     * becomes too non-linear to be useful.  The default value for this is
2123     * maximum representable value for a 16-bit raw sample (2^16 - 1).</p>
2124     * <p><b>Range of valid values:</b><br>
2125     * &gt; 255 (8-bit output)</p>
2126     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2127     *
2128     * @see CameraCharacteristics#SENSOR_BLACK_LEVEL_PATTERN
2129     */
2130    @PublicKey
2131    public static final Key<Integer> SENSOR_INFO_WHITE_LEVEL =
2132            new Key<Integer>("android.sensor.info.whiteLevel", int.class);
2133
2134    /**
2135     * <p>The time base source for sensor capture start timestamps.</p>
2136     * <p>The timestamps provided for captures are always in nanoseconds and monotonic, but
2137     * may not based on a time source that can be compared to other system time sources.</p>
2138     * <p>This characteristic defines the source for the timestamps, and therefore whether they
2139     * can be compared against other system time sources/timestamps.</p>
2140     * <p><b>Possible values:</b>
2141     * <ul>
2142     *   <li>{@link #SENSOR_INFO_TIMESTAMP_SOURCE_UNKNOWN UNKNOWN}</li>
2143     *   <li>{@link #SENSOR_INFO_TIMESTAMP_SOURCE_REALTIME REALTIME}</li>
2144     * </ul></p>
2145     * <p>This key is available on all devices.</p>
2146     * @see #SENSOR_INFO_TIMESTAMP_SOURCE_UNKNOWN
2147     * @see #SENSOR_INFO_TIMESTAMP_SOURCE_REALTIME
2148     */
2149    @PublicKey
2150    public static final Key<Integer> SENSOR_INFO_TIMESTAMP_SOURCE =
2151            new Key<Integer>("android.sensor.info.timestampSource", int.class);
2152
2153    /**
2154     * <p>Whether the RAW images output from this camera device are subject to
2155     * lens shading correction.</p>
2156     * <p>If TRUE, all images produced by the camera device in the RAW image formats will
2157     * have lens shading correction already applied to it. If FALSE, the images will
2158     * not be adjusted for lens shading correction.
2159     * See {@link CameraCharacteristics#REQUEST_MAX_NUM_OUTPUT_RAW android.request.maxNumOutputRaw} for a list of RAW image formats.</p>
2160     * <p>This key will be <code>null</code> for all devices do not report this information.
2161     * Devices with RAW capability will always report this information in this key.</p>
2162     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2163     *
2164     * @see CameraCharacteristics#REQUEST_MAX_NUM_OUTPUT_RAW
2165     */
2166    @PublicKey
2167    public static final Key<Boolean> SENSOR_INFO_LENS_SHADING_APPLIED =
2168            new Key<Boolean>("android.sensor.info.lensShadingApplied", boolean.class);
2169
2170    /**
2171     * <p>The standard reference illuminant used as the scene light source when
2172     * calculating the {@link CameraCharacteristics#SENSOR_COLOR_TRANSFORM1 android.sensor.colorTransform1},
2173     * {@link CameraCharacteristics#SENSOR_CALIBRATION_TRANSFORM1 android.sensor.calibrationTransform1}, and
2174     * {@link CameraCharacteristics#SENSOR_FORWARD_MATRIX1 android.sensor.forwardMatrix1} matrices.</p>
2175     * <p>The values in this key correspond to the values defined for the
2176     * EXIF LightSource tag. These illuminants are standard light sources
2177     * that are often used calibrating camera devices.</p>
2178     * <p>If this key is present, then {@link CameraCharacteristics#SENSOR_COLOR_TRANSFORM1 android.sensor.colorTransform1},
2179     * {@link CameraCharacteristics#SENSOR_CALIBRATION_TRANSFORM1 android.sensor.calibrationTransform1}, and
2180     * {@link CameraCharacteristics#SENSOR_FORWARD_MATRIX1 android.sensor.forwardMatrix1} will also be present.</p>
2181     * <p>Some devices may choose to provide a second set of calibration
2182     * information for improved quality, including
2183     * {@link CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT2 android.sensor.referenceIlluminant2} and its corresponding matrices.</p>
2184     * <p><b>Possible values:</b>
2185     * <ul>
2186     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT DAYLIGHT}</li>
2187     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_FLUORESCENT FLUORESCENT}</li>
2188     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_TUNGSTEN TUNGSTEN}</li>
2189     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_FLASH FLASH}</li>
2190     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_FINE_WEATHER FINE_WEATHER}</li>
2191     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_CLOUDY_WEATHER CLOUDY_WEATHER}</li>
2192     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_SHADE SHADE}</li>
2193     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT_FLUORESCENT DAYLIGHT_FLUORESCENT}</li>
2194     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_DAY_WHITE_FLUORESCENT DAY_WHITE_FLUORESCENT}</li>
2195     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_COOL_WHITE_FLUORESCENT COOL_WHITE_FLUORESCENT}</li>
2196     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_WHITE_FLUORESCENT WHITE_FLUORESCENT}</li>
2197     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_STANDARD_A STANDARD_A}</li>
2198     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_STANDARD_B STANDARD_B}</li>
2199     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_STANDARD_C STANDARD_C}</li>
2200     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_D55 D55}</li>
2201     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_D65 D65}</li>
2202     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_D75 D75}</li>
2203     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_D50 D50}</li>
2204     *   <li>{@link #SENSOR_REFERENCE_ILLUMINANT1_ISO_STUDIO_TUNGSTEN ISO_STUDIO_TUNGSTEN}</li>
2205     * </ul></p>
2206     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2207     *
2208     * @see CameraCharacteristics#SENSOR_CALIBRATION_TRANSFORM1
2209     * @see CameraCharacteristics#SENSOR_COLOR_TRANSFORM1
2210     * @see CameraCharacteristics#SENSOR_FORWARD_MATRIX1
2211     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT2
2212     * @see #SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT
2213     * @see #SENSOR_REFERENCE_ILLUMINANT1_FLUORESCENT
2214     * @see #SENSOR_REFERENCE_ILLUMINANT1_TUNGSTEN
2215     * @see #SENSOR_REFERENCE_ILLUMINANT1_FLASH
2216     * @see #SENSOR_REFERENCE_ILLUMINANT1_FINE_WEATHER
2217     * @see #SENSOR_REFERENCE_ILLUMINANT1_CLOUDY_WEATHER
2218     * @see #SENSOR_REFERENCE_ILLUMINANT1_SHADE
2219     * @see #SENSOR_REFERENCE_ILLUMINANT1_DAYLIGHT_FLUORESCENT
2220     * @see #SENSOR_REFERENCE_ILLUMINANT1_DAY_WHITE_FLUORESCENT
2221     * @see #SENSOR_REFERENCE_ILLUMINANT1_COOL_WHITE_FLUORESCENT
2222     * @see #SENSOR_REFERENCE_ILLUMINANT1_WHITE_FLUORESCENT
2223     * @see #SENSOR_REFERENCE_ILLUMINANT1_STANDARD_A
2224     * @see #SENSOR_REFERENCE_ILLUMINANT1_STANDARD_B
2225     * @see #SENSOR_REFERENCE_ILLUMINANT1_STANDARD_C
2226     * @see #SENSOR_REFERENCE_ILLUMINANT1_D55
2227     * @see #SENSOR_REFERENCE_ILLUMINANT1_D65
2228     * @see #SENSOR_REFERENCE_ILLUMINANT1_D75
2229     * @see #SENSOR_REFERENCE_ILLUMINANT1_D50
2230     * @see #SENSOR_REFERENCE_ILLUMINANT1_ISO_STUDIO_TUNGSTEN
2231     */
2232    @PublicKey
2233    public static final Key<Integer> SENSOR_REFERENCE_ILLUMINANT1 =
2234            new Key<Integer>("android.sensor.referenceIlluminant1", int.class);
2235
2236    /**
2237     * <p>The standard reference illuminant used as the scene light source when
2238     * calculating the {@link CameraCharacteristics#SENSOR_COLOR_TRANSFORM2 android.sensor.colorTransform2},
2239     * {@link CameraCharacteristics#SENSOR_CALIBRATION_TRANSFORM2 android.sensor.calibrationTransform2}, and
2240     * {@link CameraCharacteristics#SENSOR_FORWARD_MATRIX2 android.sensor.forwardMatrix2} matrices.</p>
2241     * <p>See {@link CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1 android.sensor.referenceIlluminant1} for more details.</p>
2242     * <p>If this key is present, then {@link CameraCharacteristics#SENSOR_COLOR_TRANSFORM2 android.sensor.colorTransform2},
2243     * {@link CameraCharacteristics#SENSOR_CALIBRATION_TRANSFORM2 android.sensor.calibrationTransform2}, and
2244     * {@link CameraCharacteristics#SENSOR_FORWARD_MATRIX2 android.sensor.forwardMatrix2} will also be present.</p>
2245     * <p><b>Range of valid values:</b><br>
2246     * Any value listed in {@link CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1 android.sensor.referenceIlluminant1}</p>
2247     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2248     *
2249     * @see CameraCharacteristics#SENSOR_CALIBRATION_TRANSFORM2
2250     * @see CameraCharacteristics#SENSOR_COLOR_TRANSFORM2
2251     * @see CameraCharacteristics#SENSOR_FORWARD_MATRIX2
2252     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
2253     */
2254    @PublicKey
2255    public static final Key<Byte> SENSOR_REFERENCE_ILLUMINANT2 =
2256            new Key<Byte>("android.sensor.referenceIlluminant2", byte.class);
2257
2258    /**
2259     * <p>A per-device calibration transform matrix that maps from the
2260     * reference sensor colorspace to the actual device sensor colorspace.</p>
2261     * <p>This matrix is used to correct for per-device variations in the
2262     * sensor colorspace, and is used for processing raw buffer data.</p>
2263     * <p>The matrix is expressed as a 3x3 matrix in row-major-order, and
2264     * contains a per-device calibration transform that maps colors
2265     * from reference sensor color space (i.e. the "golden module"
2266     * colorspace) into this camera device's native sensor color
2267     * space under the first reference illuminant
2268     * ({@link CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1 android.sensor.referenceIlluminant1}).</p>
2269     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2270     *
2271     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
2272     */
2273    @PublicKey
2274    public static final Key<android.hardware.camera2.params.ColorSpaceTransform> SENSOR_CALIBRATION_TRANSFORM1 =
2275            new Key<android.hardware.camera2.params.ColorSpaceTransform>("android.sensor.calibrationTransform1", android.hardware.camera2.params.ColorSpaceTransform.class);
2276
2277    /**
2278     * <p>A per-device calibration transform matrix that maps from the
2279     * reference sensor colorspace to the actual device sensor colorspace
2280     * (this is the colorspace of the raw buffer data).</p>
2281     * <p>This matrix is used to correct for per-device variations in the
2282     * sensor colorspace, and is used for processing raw buffer data.</p>
2283     * <p>The matrix is expressed as a 3x3 matrix in row-major-order, and
2284     * contains a per-device calibration transform that maps colors
2285     * from reference sensor color space (i.e. the "golden module"
2286     * colorspace) into this camera device's native sensor color
2287     * space under the second reference illuminant
2288     * ({@link CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT2 android.sensor.referenceIlluminant2}).</p>
2289     * <p>This matrix will only be present if the second reference
2290     * illuminant is present.</p>
2291     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2292     *
2293     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT2
2294     */
2295    @PublicKey
2296    public static final Key<android.hardware.camera2.params.ColorSpaceTransform> SENSOR_CALIBRATION_TRANSFORM2 =
2297            new Key<android.hardware.camera2.params.ColorSpaceTransform>("android.sensor.calibrationTransform2", android.hardware.camera2.params.ColorSpaceTransform.class);
2298
2299    /**
2300     * <p>A matrix that transforms color values from CIE XYZ color space to
2301     * reference sensor color space.</p>
2302     * <p>This matrix is used to convert from the standard CIE XYZ color
2303     * space to the reference sensor colorspace, and is used when processing
2304     * raw buffer data.</p>
2305     * <p>The matrix is expressed as a 3x3 matrix in row-major-order, and
2306     * contains a color transform matrix that maps colors from the CIE
2307     * XYZ color space to the reference sensor color space (i.e. the
2308     * "golden module" colorspace) under the first reference illuminant
2309     * ({@link CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1 android.sensor.referenceIlluminant1}).</p>
2310     * <p>The white points chosen in both the reference sensor color space
2311     * and the CIE XYZ colorspace when calculating this transform will
2312     * match the standard white point for the first reference illuminant
2313     * (i.e. no chromatic adaptation will be applied by this transform).</p>
2314     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2315     *
2316     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
2317     */
2318    @PublicKey
2319    public static final Key<android.hardware.camera2.params.ColorSpaceTransform> SENSOR_COLOR_TRANSFORM1 =
2320            new Key<android.hardware.camera2.params.ColorSpaceTransform>("android.sensor.colorTransform1", android.hardware.camera2.params.ColorSpaceTransform.class);
2321
2322    /**
2323     * <p>A matrix that transforms color values from CIE XYZ color space to
2324     * reference sensor color space.</p>
2325     * <p>This matrix is used to convert from the standard CIE XYZ color
2326     * space to the reference sensor colorspace, and is used when processing
2327     * raw buffer data.</p>
2328     * <p>The matrix is expressed as a 3x3 matrix in row-major-order, and
2329     * contains a color transform matrix that maps colors from the CIE
2330     * XYZ color space to the reference sensor color space (i.e. the
2331     * "golden module" colorspace) under the second reference illuminant
2332     * ({@link CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT2 android.sensor.referenceIlluminant2}).</p>
2333     * <p>The white points chosen in both the reference sensor color space
2334     * and the CIE XYZ colorspace when calculating this transform will
2335     * match the standard white point for the second reference illuminant
2336     * (i.e. no chromatic adaptation will be applied by this transform).</p>
2337     * <p>This matrix will only be present if the second reference
2338     * illuminant is present.</p>
2339     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2340     *
2341     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT2
2342     */
2343    @PublicKey
2344    public static final Key<android.hardware.camera2.params.ColorSpaceTransform> SENSOR_COLOR_TRANSFORM2 =
2345            new Key<android.hardware.camera2.params.ColorSpaceTransform>("android.sensor.colorTransform2", android.hardware.camera2.params.ColorSpaceTransform.class);
2346
2347    /**
2348     * <p>A matrix that transforms white balanced camera colors from the reference
2349     * sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.</p>
2350     * <p>This matrix is used to convert to the standard CIE XYZ colorspace, and
2351     * is used when processing raw buffer data.</p>
2352     * <p>This matrix is expressed as a 3x3 matrix in row-major-order, and contains
2353     * a color transform matrix that maps white balanced colors from the
2354     * reference sensor color space to the CIE XYZ color space with a D50 white
2355     * point.</p>
2356     * <p>Under the first reference illuminant ({@link CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1 android.sensor.referenceIlluminant1})
2357     * this matrix is chosen so that the standard white point for this reference
2358     * illuminant in the reference sensor colorspace is mapped to D50 in the
2359     * CIE XYZ colorspace.</p>
2360     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2361     *
2362     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT1
2363     */
2364    @PublicKey
2365    public static final Key<android.hardware.camera2.params.ColorSpaceTransform> SENSOR_FORWARD_MATRIX1 =
2366            new Key<android.hardware.camera2.params.ColorSpaceTransform>("android.sensor.forwardMatrix1", android.hardware.camera2.params.ColorSpaceTransform.class);
2367
2368    /**
2369     * <p>A matrix that transforms white balanced camera colors from the reference
2370     * sensor colorspace to the CIE XYZ colorspace with a D50 whitepoint.</p>
2371     * <p>This matrix is used to convert to the standard CIE XYZ colorspace, and
2372     * is used when processing raw buffer data.</p>
2373     * <p>This matrix is expressed as a 3x3 matrix in row-major-order, and contains
2374     * a color transform matrix that maps white balanced colors from the
2375     * reference sensor color space to the CIE XYZ color space with a D50 white
2376     * point.</p>
2377     * <p>Under the second reference illuminant ({@link CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT2 android.sensor.referenceIlluminant2})
2378     * this matrix is chosen so that the standard white point for this reference
2379     * illuminant in the reference sensor colorspace is mapped to D50 in the
2380     * CIE XYZ colorspace.</p>
2381     * <p>This matrix will only be present if the second reference
2382     * illuminant is present.</p>
2383     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2384     *
2385     * @see CameraCharacteristics#SENSOR_REFERENCE_ILLUMINANT2
2386     */
2387    @PublicKey
2388    public static final Key<android.hardware.camera2.params.ColorSpaceTransform> SENSOR_FORWARD_MATRIX2 =
2389            new Key<android.hardware.camera2.params.ColorSpaceTransform>("android.sensor.forwardMatrix2", android.hardware.camera2.params.ColorSpaceTransform.class);
2390
2391    /**
2392     * <p>A fixed black level offset for each of the color filter arrangement
2393     * (CFA) mosaic channels.</p>
2394     * <p>This key specifies the zero light value for each of the CFA mosaic
2395     * channels in the camera sensor.  The maximal value output by the
2396     * sensor is represented by the value in {@link CameraCharacteristics#SENSOR_INFO_WHITE_LEVEL android.sensor.info.whiteLevel}.</p>
2397     * <p>The values are given in the same order as channels listed for the CFA
2398     * layout key (see {@link CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT android.sensor.info.colorFilterArrangement}), i.e. the
2399     * nth value given corresponds to the black level offset for the nth
2400     * color channel listed in the CFA.</p>
2401     * <p><b>Range of valid values:</b><br>
2402     * &gt;= 0 for each.</p>
2403     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2404     *
2405     * @see CameraCharacteristics#SENSOR_INFO_COLOR_FILTER_ARRANGEMENT
2406     * @see CameraCharacteristics#SENSOR_INFO_WHITE_LEVEL
2407     */
2408    @PublicKey
2409    public static final Key<android.hardware.camera2.params.BlackLevelPattern> SENSOR_BLACK_LEVEL_PATTERN =
2410            new Key<android.hardware.camera2.params.BlackLevelPattern>("android.sensor.blackLevelPattern", android.hardware.camera2.params.BlackLevelPattern.class);
2411
2412    /**
2413     * <p>Maximum sensitivity that is implemented
2414     * purely through analog gain.</p>
2415     * <p>For {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity} values less than or
2416     * equal to this, all applied gain must be analog. For
2417     * values above this, the gain applied can be a mix of analog and
2418     * digital.</p>
2419     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2420     * <p><b>Full capability</b> -
2421     * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
2422     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2423     *
2424     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2425     * @see CaptureRequest#SENSOR_SENSITIVITY
2426     */
2427    @PublicKey
2428    public static final Key<Integer> SENSOR_MAX_ANALOG_SENSITIVITY =
2429            new Key<Integer>("android.sensor.maxAnalogSensitivity", int.class);
2430
2431    /**
2432     * <p>Clockwise angle through which the output image needs to be rotated to be
2433     * upright on the device screen in its native orientation.</p>
2434     * <p>Also defines the direction of rolling shutter readout, which is from top to bottom in
2435     * the sensor's coordinate system.</p>
2436     * <p><b>Units</b>: Degrees of clockwise rotation; always a multiple of
2437     * 90</p>
2438     * <p><b>Range of valid values:</b><br>
2439     * 0, 90, 180, 270</p>
2440     * <p>This key is available on all devices.</p>
2441     */
2442    @PublicKey
2443    public static final Key<Integer> SENSOR_ORIENTATION =
2444            new Key<Integer>("android.sensor.orientation", int.class);
2445
2446    /**
2447     * <p>List of sensor test pattern modes for {@link CaptureRequest#SENSOR_TEST_PATTERN_MODE android.sensor.testPatternMode}
2448     * supported by this camera device.</p>
2449     * <p>Defaults to OFF, and always includes OFF if defined.</p>
2450     * <p><b>Range of valid values:</b><br>
2451     * Any value listed in {@link CaptureRequest#SENSOR_TEST_PATTERN_MODE android.sensor.testPatternMode}</p>
2452     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2453     *
2454     * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE
2455     */
2456    @PublicKey
2457    public static final Key<int[]> SENSOR_AVAILABLE_TEST_PATTERN_MODES =
2458            new Key<int[]>("android.sensor.availableTestPatternModes", int[].class);
2459
2460    /**
2461     * <p>List of lens shading modes for {@link CaptureRequest#SHADING_MODE android.shading.mode} that are supported by this camera device.</p>
2462     * <p>This list contains lens shading modes that can be set for the camera device.
2463     * Camera devices that support the MANUAL_POST_PROCESSING capability will always
2464     * list OFF and FAST mode. This includes all FULL level devices.
2465     * LEGACY devices will always only support FAST mode.</p>
2466     * <p><b>Range of valid values:</b><br>
2467     * Any value listed in {@link CaptureRequest#SHADING_MODE android.shading.mode}</p>
2468     * <p>This key is available on all devices.</p>
2469     *
2470     * @see CaptureRequest#SHADING_MODE
2471     */
2472    @PublicKey
2473    public static final Key<int[]> SHADING_AVAILABLE_MODES =
2474            new Key<int[]>("android.shading.availableModes", int[].class);
2475
2476    /**
2477     * <p>List of face detection modes for {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode} that are
2478     * supported by this camera device.</p>
2479     * <p>OFF is always supported.</p>
2480     * <p><b>Range of valid values:</b><br>
2481     * Any value listed in {@link CaptureRequest#STATISTICS_FACE_DETECT_MODE android.statistics.faceDetectMode}</p>
2482     * <p>This key is available on all devices.</p>
2483     *
2484     * @see CaptureRequest#STATISTICS_FACE_DETECT_MODE
2485     */
2486    @PublicKey
2487    public static final Key<int[]> STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES =
2488            new Key<int[]>("android.statistics.info.availableFaceDetectModes", int[].class);
2489
2490    /**
2491     * <p>The maximum number of simultaneously detectable
2492     * faces.</p>
2493     * <p><b>Range of valid values:</b><br>
2494     * 0 for cameras without available face detection; otherwise:
2495     * <code>&gt;=4</code> for LIMITED or FULL hwlevel devices or
2496     * <code>&gt;0</code> for LEGACY devices.</p>
2497     * <p>This key is available on all devices.</p>
2498     */
2499    @PublicKey
2500    public static final Key<Integer> STATISTICS_INFO_MAX_FACE_COUNT =
2501            new Key<Integer>("android.statistics.info.maxFaceCount", int.class);
2502
2503    /**
2504     * <p>List of hot pixel map output modes for {@link CaptureRequest#STATISTICS_HOT_PIXEL_MAP_MODE android.statistics.hotPixelMapMode} that are
2505     * supported by this camera device.</p>
2506     * <p>If no hotpixel map output is available for this camera device, this will contain only
2507     * <code>false</code>.</p>
2508     * <p>ON is always supported on devices with the RAW capability.</p>
2509     * <p><b>Range of valid values:</b><br>
2510     * Any value listed in {@link CaptureRequest#STATISTICS_HOT_PIXEL_MAP_MODE android.statistics.hotPixelMapMode}</p>
2511     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2512     *
2513     * @see CaptureRequest#STATISTICS_HOT_PIXEL_MAP_MODE
2514     */
2515    @PublicKey
2516    public static final Key<boolean[]> STATISTICS_INFO_AVAILABLE_HOT_PIXEL_MAP_MODES =
2517            new Key<boolean[]>("android.statistics.info.availableHotPixelMapModes", boolean[].class);
2518
2519    /**
2520     * <p>List of lens shading map output modes for {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode} that
2521     * are supported by this camera device.</p>
2522     * <p>If no lens shading map output is available for this camera device, this key will
2523     * contain only OFF.</p>
2524     * <p>ON is always supported on devices with the RAW capability.
2525     * LEGACY mode devices will always only support OFF.</p>
2526     * <p><b>Range of valid values:</b><br>
2527     * Any value listed in {@link CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE android.statistics.lensShadingMapMode}</p>
2528     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2529     *
2530     * @see CaptureRequest#STATISTICS_LENS_SHADING_MAP_MODE
2531     */
2532    @PublicKey
2533    public static final Key<int[]> STATISTICS_INFO_AVAILABLE_LENS_SHADING_MAP_MODES =
2534            new Key<int[]>("android.statistics.info.availableLensShadingMapModes", int[].class);
2535
2536    /**
2537     * <p>Maximum number of supported points in the
2538     * tonemap curve that can be used for {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}.</p>
2539     * <p>If the actual number of points provided by the application (in {@link CaptureRequest#TONEMAP_CURVE android.tonemap.curve}*) is
2540     * less than this maximum, the camera device will resample the curve to its internal
2541     * representation, using linear interpolation.</p>
2542     * <p>The output curves in the result metadata may have a different number
2543     * of points than the input curves, and will represent the actual
2544     * hardware curves used as closely as possible when linearly interpolated.</p>
2545     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2546     * <p><b>Full capability</b> -
2547     * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
2548     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2549     *
2550     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2551     * @see CaptureRequest#TONEMAP_CURVE
2552     */
2553    @PublicKey
2554    public static final Key<Integer> TONEMAP_MAX_CURVE_POINTS =
2555            new Key<Integer>("android.tonemap.maxCurvePoints", int.class);
2556
2557    /**
2558     * <p>List of tonemapping modes for {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode} that are supported by this camera
2559     * device.</p>
2560     * <p>Camera devices that support the MANUAL_POST_PROCESSING capability will always contain
2561     * at least one of below mode combinations:</p>
2562     * <ul>
2563     * <li>CONTRAST_CURVE, FAST and HIGH_QUALITY</li>
2564     * <li>GAMMA_VALUE, PRESET_CURVE, FAST and HIGH_QUALITY</li>
2565     * </ul>
2566     * <p>This includes all FULL level devices.</p>
2567     * <p><b>Range of valid values:</b><br>
2568     * Any value listed in {@link CaptureRequest#TONEMAP_MODE android.tonemap.mode}</p>
2569     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2570     * <p><b>Full capability</b> -
2571     * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
2572     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2573     *
2574     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2575     * @see CaptureRequest#TONEMAP_MODE
2576     */
2577    @PublicKey
2578    public static final Key<int[]> TONEMAP_AVAILABLE_TONE_MAP_MODES =
2579            new Key<int[]>("android.tonemap.availableToneMapModes", int[].class);
2580
2581    /**
2582     * <p>A list of camera LEDs that are available on this system.</p>
2583     * <p><b>Possible values:</b>
2584     * <ul>
2585     *   <li>{@link #LED_AVAILABLE_LEDS_TRANSMIT TRANSMIT}</li>
2586     * </ul></p>
2587     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2588     * @see #LED_AVAILABLE_LEDS_TRANSMIT
2589     * @hide
2590     */
2591    public static final Key<int[]> LED_AVAILABLE_LEDS =
2592            new Key<int[]>("android.led.availableLeds", int[].class);
2593
2594    /**
2595     * <p>Generally classifies the overall set of the camera device functionality.</p>
2596     * <p>Camera devices will come in three flavors: LEGACY, LIMITED and FULL.</p>
2597     * <p>A FULL device will support below capabilities:</p>
2598     * <ul>
2599     * <li>30fps operation at maximum resolution (== sensor resolution) is preferred, more than
2600     *   20fps is required, for at least uncompressed YUV
2601     *   output. ({@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} contains BURST_CAPTURE)</li>
2602     * <li>Per frame control ({@link CameraCharacteristics#SYNC_MAX_LATENCY android.sync.maxLatency} <code>==</code> PER_FRAME_CONTROL)</li>
2603     * <li>Manual sensor control ({@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} contains MANUAL_SENSOR)</li>
2604     * <li>Manual post-processing control ({@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} contains
2605     *   MANUAL_POST_PROCESSING)</li>
2606     * <li>Arbitrary cropping region ({@link CameraCharacteristics#SCALER_CROPPING_TYPE android.scaler.croppingType} <code>==</code> FREEFORM)</li>
2607     * <li>At least 3 processed (but not stalling) format output streams
2608     *   ({@link CameraCharacteristics#REQUEST_MAX_NUM_OUTPUT_PROC android.request.maxNumOutputProc} <code>&gt;=</code> 3)</li>
2609     * <li>The required stream configuration defined in android.scaler.availableStreamConfigurations</li>
2610     * <li>The required exposure time range defined in {@link CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE android.sensor.info.exposureTimeRange}</li>
2611     * <li>The required maxFrameDuration defined in {@link CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION android.sensor.info.maxFrameDuration}</li>
2612     * </ul>
2613     * <p>A LIMITED device may have some or none of the above characteristics.
2614     * To find out more refer to {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities}.</p>
2615     * <p>Some features are not part of any particular hardware level or capability and must be
2616     * queried separately. These include:</p>
2617     * <ul>
2618     * <li>Calibrated timestamps ({@link CameraCharacteristics#SENSOR_INFO_TIMESTAMP_SOURCE android.sensor.info.timestampSource} <code>==</code> REALTIME)</li>
2619     * <li>Precision lens control ({@link CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION android.lens.info.focusDistanceCalibration} <code>==</code> CALIBRATED)</li>
2620     * <li>Face detection ({@link CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES android.statistics.info.availableFaceDetectModes})</li>
2621     * <li>Optical or electrical image stabilization
2622     *   ({@link CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION android.lens.info.availableOpticalStabilization},
2623     *    {@link CameraCharacteristics#CONTROL_AVAILABLE_VIDEO_STABILIZATION_MODES android.control.availableVideoStabilizationModes})</li>
2624     * </ul>
2625     * <p>A LEGACY device does not support per-frame control, manual sensor control, manual
2626     * post-processing, arbitrary cropping regions, and has relaxed performance constraints.</p>
2627     * <p>Each higher level supports everything the lower level supports
2628     * in this order: FULL <code>&gt;</code> LIMITED <code>&gt;</code> LEGACY.</p>
2629     * <p>A HIGH_RESOLUTION device is equivalent to a FULL device, except that:</p>
2630     * <ul>
2631     * <li>At least one output resolution of 8 megapixels or higher in uncompressed YUV is
2632     *   supported at <code>&gt;=</code> 20 fps.</li>
2633     * <li>Maximum-size (sensor resolution) uncompressed YUV is supported  at <code>&gt;=</code> 10
2634     *   fps.</li>
2635     * <li>For devices that list the RAW capability and support either RAW10 or RAW12 output,
2636     *   maximum-resolution RAW10 or RAW12 capture will operate at least at the rate of
2637     *   maximum-resolution YUV capture, and at least one supported output resolution of
2638     *   8 megapixels or higher in RAW10 or RAW12 is supported <code>&gt;=</code> 20 fps.</li>
2639     * </ul>
2640     * <p><b>Possible values:</b>
2641     * <ul>
2642     *   <li>{@link #INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED LIMITED}</li>
2643     *   <li>{@link #INFO_SUPPORTED_HARDWARE_LEVEL_FULL FULL}</li>
2644     *   <li>{@link #INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY LEGACY}</li>
2645     *   <li>{@link #INFO_SUPPORTED_HARDWARE_LEVEL_HIGH_RESOLUTION HIGH_RESOLUTION}</li>
2646     * </ul></p>
2647     * <p>This key is available on all devices.</p>
2648     *
2649     * @see CameraCharacteristics#CONTROL_AVAILABLE_VIDEO_STABILIZATION_MODES
2650     * @see CameraCharacteristics#LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION
2651     * @see CameraCharacteristics#LENS_INFO_FOCUS_DISTANCE_CALIBRATION
2652     * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
2653     * @see CameraCharacteristics#REQUEST_MAX_NUM_OUTPUT_PROC
2654     * @see CameraCharacteristics#SCALER_CROPPING_TYPE
2655     * @see CameraCharacteristics#SENSOR_INFO_EXPOSURE_TIME_RANGE
2656     * @see CameraCharacteristics#SENSOR_INFO_MAX_FRAME_DURATION
2657     * @see CameraCharacteristics#SENSOR_INFO_TIMESTAMP_SOURCE
2658     * @see CameraCharacteristics#STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES
2659     * @see CameraCharacteristics#SYNC_MAX_LATENCY
2660     * @see #INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED
2661     * @see #INFO_SUPPORTED_HARDWARE_LEVEL_FULL
2662     * @see #INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY
2663     * @see #INFO_SUPPORTED_HARDWARE_LEVEL_HIGH_RESOLUTION
2664     */
2665    @PublicKey
2666    public static final Key<Integer> INFO_SUPPORTED_HARDWARE_LEVEL =
2667            new Key<Integer>("android.info.supportedHardwareLevel", int.class);
2668
2669    /**
2670     * <p>The maximum number of frames that can occur after a request
2671     * (different than the previous) has been submitted, and before the
2672     * result's state becomes synchronized (by setting
2673     * android.sync.frameNumber to a non-negative value).</p>
2674     * <p>This defines the maximum distance (in number of metadata results),
2675     * between android.sync.frameNumber and the equivalent
2676     * frame number for that result.</p>
2677     * <p>In other words this acts as an upper boundary for how many frames
2678     * must occur before the camera device knows for a fact that the new
2679     * submitted camera settings have been applied in outgoing frames.</p>
2680     * <p>For example if the distance was 2,</p>
2681     * <pre><code>initial request = X (repeating)
2682     * request1 = X
2683     * request2 = Y
2684     * request3 = Y
2685     * request4 = Y
2686     *
2687     * where requestN has frameNumber N, and the first of the repeating
2688     * initial request's has frameNumber F (and F &lt; 1).
2689     *
2690     * initial result = X' + { android.sync.frameNumber == F }
2691     * result1 = X' + { android.sync.frameNumber == F }
2692     * result2 = X' + { android.sync.frameNumber == CONVERGING }
2693     * result3 = X' + { android.sync.frameNumber == CONVERGING }
2694     * result4 = X' + { android.sync.frameNumber == 2 }
2695     *
2696     * where resultN has frameNumber N.
2697     * </code></pre>
2698     * <p>Since <code>result4</code> has a <code>frameNumber == 4</code> and
2699     * <code>android.sync.frameNumber == 2</code>, the distance is clearly
2700     * <code>4 - 2 = 2</code>.</p>
2701     * <p><b>Units</b>: Frame counts</p>
2702     * <p><b>Possible values:</b>
2703     * <ul>
2704     *   <li>{@link #SYNC_MAX_LATENCY_PER_FRAME_CONTROL PER_FRAME_CONTROL}</li>
2705     *   <li>{@link #SYNC_MAX_LATENCY_UNKNOWN UNKNOWN}</li>
2706     * </ul></p>
2707     * <p><b>Available values for this device:</b><br>
2708     * A positive value, PER_FRAME_CONTROL, or UNKNOWN.</p>
2709     * <p>This key is available on all devices.</p>
2710     * @see #SYNC_MAX_LATENCY_PER_FRAME_CONTROL
2711     * @see #SYNC_MAX_LATENCY_UNKNOWN
2712     */
2713    @PublicKey
2714    public static final Key<Integer> SYNC_MAX_LATENCY =
2715            new Key<Integer>("android.sync.maxLatency", int.class);
2716
2717    /**
2718     * <p>The maximal camera capture pipeline stall (in unit of frame count) introduced by a
2719     * reprocess capture request.</p>
2720     * <p>The key describes the maximal interference that one reprocess (input) request
2721     * can introduce to the camera simultaneous streaming of regular (output) capture
2722     * requests, including repeating requests.</p>
2723     * <p>When a reprocessing capture request is submitted while a camera output repeating request
2724     * (e.g. preview) is being served by the camera device, it may preempt the camera capture
2725     * pipeline for at least one frame duration so that the camera device is unable to process
2726     * the following capture request in time for the next sensor start of exposure boundary.
2727     * When this happens, the application may observe a capture time gap (longer than one frame
2728     * duration) between adjacent capture output frames, which usually exhibits as preview
2729     * glitch if the repeating request output targets include a preview surface. This key gives
2730     * the worst-case number of frame stall introduced by one reprocess request with any kind of
2731     * formats/sizes combination.</p>
2732     * <p>If this key reports 0, it means a reprocess request doesn't introduce any glitch to the
2733     * ongoing camera repeating request outputs, as if this reprocess request is never issued.</p>
2734     * <p>This key is supported if the camera device supports PRIVATE or YUV reprocessing (
2735     * i.e. {@link CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES android.request.availableCapabilities} contains PRIVATE_REPROCESSING or
2736     * YUV_REPROCESSING).</p>
2737     * <p><b>Units</b>: Number of frames.</p>
2738     * <p><b>Range of valid values:</b><br>
2739     * &lt;= 4</p>
2740     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2741     * <p><b>Limited capability</b> -
2742     * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
2743     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2744     *
2745     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2746     * @see CameraCharacteristics#REQUEST_AVAILABLE_CAPABILITIES
2747     */
2748    @PublicKey
2749    public static final Key<Integer> REPROCESS_MAX_CAPTURE_STALL =
2750            new Key<Integer>("android.reprocess.maxCaptureStall", int.class);
2751
2752    /**
2753     * <p>The available depth dataspace stream
2754     * configurations that this camera device supports
2755     * (i.e. format, width, height, output/input stream).</p>
2756     * <p>These are output stream configurations for use with
2757     * dataSpace HAL_DATASPACE_DEPTH. The configurations are
2758     * listed as <code>(format, width, height, input?)</code> tuples.</p>
2759     * <p>Only devices that support depth output for at least
2760     * the HAL_PIXEL_FORMAT_Y16 dense depth map may include
2761     * this entry.</p>
2762     * <p>A device that also supports the HAL_PIXEL_FORMAT_BLOB
2763     * sparse depth point cloud must report a single entry for
2764     * the format in this list as <code>(HAL_PIXEL_FORMAT_BLOB,
2765     * android.depth.maxDepthSamples, 1, OUTPUT)</code> in addition to
2766     * the entries for HAL_PIXEL_FORMAT_Y16.</p>
2767     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2768     * <p><b>Limited capability</b> -
2769     * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
2770     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2771     *
2772     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2773     * @hide
2774     */
2775    public static final Key<android.hardware.camera2.params.StreamConfiguration[]> DEPTH_AVAILABLE_DEPTH_STREAM_CONFIGURATIONS =
2776            new Key<android.hardware.camera2.params.StreamConfiguration[]>("android.depth.availableDepthStreamConfigurations", android.hardware.camera2.params.StreamConfiguration[].class);
2777
2778    /**
2779     * <p>This lists the minimum frame duration for each
2780     * format/size combination for depth output formats.</p>
2781     * <p>This should correspond to the frame duration when only that
2782     * stream is active, with all processing (typically in android.*.mode)
2783     * set to either OFF or FAST.</p>
2784     * <p>When multiple streams are used in a request, the minimum frame
2785     * duration will be max(individual stream min durations).</p>
2786     * <p>The minimum frame duration of a stream (of a particular format, size)
2787     * is the same regardless of whether the stream is input or output.</p>
2788     * <p>See {@link CaptureRequest#SENSOR_FRAME_DURATION android.sensor.frameDuration} and
2789     * android.scaler.availableStallDurations for more details about
2790     * calculating the max frame rate.</p>
2791     * <p>(Keep in sync with {@link android.hardware.camera2.params.StreamConfigurationMap#getOutputMinFrameDuration })</p>
2792     * <p><b>Units</b>: (format, width, height, ns) x n</p>
2793     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2794     * <p><b>Limited capability</b> -
2795     * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
2796     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2797     *
2798     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2799     * @see CaptureRequest#SENSOR_FRAME_DURATION
2800     * @hide
2801     */
2802    public static final Key<android.hardware.camera2.params.StreamConfigurationDuration[]> DEPTH_AVAILABLE_DEPTH_MIN_FRAME_DURATIONS =
2803            new Key<android.hardware.camera2.params.StreamConfigurationDuration[]>("android.depth.availableDepthMinFrameDurations", android.hardware.camera2.params.StreamConfigurationDuration[].class);
2804
2805    /**
2806     * <p>This lists the maximum stall duration for each
2807     * output format/size combination for depth streams.</p>
2808     * <p>A stall duration is how much extra time would get added
2809     * to the normal minimum frame duration for a repeating request
2810     * that has streams with non-zero stall.</p>
2811     * <p>This functions similarly to
2812     * android.scaler.availableStallDurations for depth
2813     * streams.</p>
2814     * <p>All depth output stream formats may have a nonzero stall
2815     * duration.</p>
2816     * <p><b>Units</b>: (format, width, height, ns) x n</p>
2817     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2818     * <p><b>Limited capability</b> -
2819     * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
2820     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2821     *
2822     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2823     * @hide
2824     */
2825    public static final Key<android.hardware.camera2.params.StreamConfigurationDuration[]> DEPTH_AVAILABLE_DEPTH_STALL_DURATIONS =
2826            new Key<android.hardware.camera2.params.StreamConfigurationDuration[]>("android.depth.availableDepthStallDurations", android.hardware.camera2.params.StreamConfigurationDuration[].class);
2827
2828    /**
2829     * <p>Indicates whether a capture request may target both a
2830     * DEPTH16 / DEPTH_POINT_CLOUD output, and normal color outputs (such as
2831     * YUV_420_888, JPEG, or RAW) simultaneously.</p>
2832     * <p>If TRUE, including both depth and color outputs in a single
2833     * capture request is not supported. An application must interleave color
2834     * and depth requests.  If FALSE, a single request can target both types
2835     * of output.</p>
2836     * <p>Typically, this restriction exists on camera devices that
2837     * need to emit a specific pattern or wavelength of light to
2838     * measure depth values, which causes the color image to be
2839     * corrupted during depth measurement.</p>
2840     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
2841     * <p><b>Limited capability</b> -
2842     * Present on all camera devices that report being at least {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED HARDWARE_LEVEL_LIMITED} devices in the
2843     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
2844     *
2845     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
2846     */
2847    @PublicKey
2848    public static final Key<Boolean> DEPTH_DEPTH_IS_EXCLUSIVE =
2849            new Key<Boolean>("android.depth.depthIsExclusive", boolean.class);
2850
2851    /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~
2852     * End generated code
2853     *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/
2854
2855
2856
2857}
2858