CameraCharacteristics.java revision 1ef676f23c48c9144edd436933e863e07d6c309b
1/*
2 * Copyright (C) 2013 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.hardware.camera2;
18
19import android.hardware.camera2.impl.CameraMetadataNative;
20
21import java.util.Collections;
22import java.util.List;
23
24/**
25 * <p>The properties describing a
26 * {@link CameraDevice CameraDevice}.</p>
27 *
28 * <p>These properties are fixed for a given CameraDevice, and can be queried
29 * through the {@link CameraManager CameraManager}
30 * interface in addition to through the CameraDevice interface.</p>
31 *
32 * @see CameraDevice
33 * @see CameraManager
34 */
35public final class CameraCharacteristics extends CameraMetadata {
36
37    private final CameraMetadataNative mProperties;
38    private List<Key<?>> mAvailableRequestKeys;
39    private List<Key<?>> mAvailableResultKeys;
40
41    /**
42     * Takes ownership of the passed-in properties object
43     * @hide
44     */
45    public CameraCharacteristics(CameraMetadataNative properties) {
46        mProperties = properties;
47    }
48
49    @Override
50    public <T> T get(Key<T> key) {
51        return mProperties.get(key);
52    }
53
54    /**
55     * Returns the list of keys supported by this {@link CameraDevice} for querying
56     * with a {@link CaptureRequest}.
57     *
58     * <p>The list returned is not modifiable, so any attempts to modify it will throw
59     * a {@code UnsupportedOperationException}.</p>
60     *
61     * <p>Each key is only listed once in the list. The order of the keys is undefined.</p>
62     *
63     * <p>Note that there is no {@code getAvailableCameraCharacteristicsKeys()} -- use
64     * {@link #getKeys()} instead.</p>
65     *
66     * @return List of keys supported by this CameraDevice for CaptureRequests.
67     */
68    public List<Key<?>> getAvailableCaptureRequestKeys() {
69        if (mAvailableRequestKeys == null) {
70            mAvailableRequestKeys = getAvailableKeyList(CaptureRequest.class);
71        }
72        return mAvailableRequestKeys;
73    }
74
75    /**
76     * Returns the list of keys supported by this {@link CameraDevice} for querying
77     * with a {@link CaptureResult}.
78     *
79     * <p>The list returned is not modifiable, so any attempts to modify it will throw
80     * a {@code UnsupportedOperationException}.</p>
81     *
82     * <p>Each key is only listed once in the list. The order of the keys is undefined.</p>
83     *
84     * <p>Note that there is no {@code getAvailableCameraCharacteristicsKeys()} -- use
85     * {@link #getKeys()} instead.</p>
86     *
87     * @return List of keys supported by this CameraDevice for CaptureResults.
88     */
89    public List<Key<?>> getAvailableCaptureResultKeys() {
90        if (mAvailableResultKeys == null) {
91            mAvailableResultKeys = getAvailableKeyList(CaptureResult.class);
92        }
93        return mAvailableResultKeys;
94    }
95
96    /**
97     * Returns the list of keys supported by this {@link CameraDevice} by metadataClass.
98     *
99     * <p>The list returned is not modifiable, so any attempts to modify it will throw
100     * a {@code UnsupportedOperationException}.</p>
101     *
102     * <p>Each key is only listed once in the list. The order of the keys is undefined.</p>
103     *
104     * @param metadataClass The subclass of CameraMetadata that you want to get the keys for.
105     *
106     * @return List of keys supported by this CameraDevice for metadataClass.
107     *
108     * @throws IllegalArgumentException if metadataClass is not a subclass of CameraMetadata
109     */
110    private <T extends CameraMetadata> List<Key<?>> getAvailableKeyList(Class<T> metadataClass) {
111
112        if (metadataClass.equals(CameraMetadata.class)) {
113            throw new AssertionError(
114                    "metadataClass must be a strict subclass of CameraMetadata");
115        } else if (!CameraMetadata.class.isAssignableFrom(metadataClass)) {
116            throw new AssertionError(
117                    "metadataClass must be a subclass of CameraMetadata");
118        }
119
120        return Collections.unmodifiableList(getKeysStatic(metadataClass, /*instance*/null));
121    }
122
123    /*@O~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~
124     * The key entries below this point are generated from metadata
125     * definitions in /system/media/camera/docs. Do not modify by hand or
126     * modify the comment blocks at the start or end.
127     *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~*/
128
129
130    /**
131     * <p>The set of auto-exposure antibanding modes that are
132     * supported by this camera device.</p>
133     * <p>Not all of the auto-exposure anti-banding modes may be
134     * supported by a given camera device. This field lists the
135     * valid anti-banding modes that the application may request
136     * for this camera device; they must include AUTO.</p>
137     */
138    public static final Key<byte[]> CONTROL_AE_AVAILABLE_ANTIBANDING_MODES =
139            new Key<byte[]>("android.control.aeAvailableAntibandingModes", byte[].class);
140
141    /**
142     * <p>The set of auto-exposure modes that are supported by this
143     * camera device.</p>
144     * <p>Not all the auto-exposure modes may be supported by a
145     * given camera device, especially if no flash unit is
146     * available. This entry lists the valid modes for
147     * {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} for this camera device.</p>
148     * <p>All camera devices support ON, and all camera devices with
149     * flash units support ON_AUTO_FLASH and
150     * ON_ALWAYS_FLASH.</p>
151     * <p>Full-capability camera devices always support OFF mode,
152     * which enables application control of camera exposure time,
153     * sensitivity, and frame duration.</p>
154     *
155     * @see CaptureRequest#CONTROL_AE_MODE
156     */
157    public static final Key<byte[]> CONTROL_AE_AVAILABLE_MODES =
158            new Key<byte[]>("android.control.aeAvailableModes", byte[].class);
159
160    /**
161     * <p>List of frame rate ranges supported by the
162     * AE algorithm/hardware</p>
163     */
164    public static final Key<int[]> CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES =
165            new Key<int[]>("android.control.aeAvailableTargetFpsRanges", int[].class);
166
167    /**
168     * <p>Maximum and minimum exposure compensation
169     * setting, in counts of
170     * android.control.aeCompensationStepSize</p>
171     */
172    public static final Key<int[]> CONTROL_AE_COMPENSATION_RANGE =
173            new Key<int[]>("android.control.aeCompensationRange", int[].class);
174
175    /**
176     * <p>Smallest step by which exposure compensation
177     * can be changed</p>
178     */
179    public static final Key<Rational> CONTROL_AE_COMPENSATION_STEP =
180            new Key<Rational>("android.control.aeCompensationStep", Rational.class);
181
182    /**
183     * <p>List of AF modes that can be
184     * selected with {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}.</p>
185     * <p>Not all the auto-focus modes may be supported by a
186     * given camera device. This entry lists the valid modes for
187     * {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode} for this camera device.</p>
188     * <p>All camera devices will support OFF mode, and all camera devices with
189     * adjustable focuser units (<code>{@link CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE android.lens.info.minimumFocusDistance} &gt; 0</code>)
190     * will support AUTO mode.</p>
191     *
192     * @see CaptureRequest#CONTROL_AF_MODE
193     * @see CameraCharacteristics#LENS_INFO_MINIMUM_FOCUS_DISTANCE
194     */
195    public static final Key<byte[]> CONTROL_AF_AVAILABLE_MODES =
196            new Key<byte[]>("android.control.afAvailableModes", byte[].class);
197
198    /**
199     * <p>List containing the subset of color effects
200     * specified in {@link CaptureRequest#CONTROL_EFFECT_MODE android.control.effectMode} that is supported by
201     * this device.</p>
202     * <p>This list contains the color effect modes that can be applied to
203     * images produced by the camera device. Only modes that have
204     * been fully implemented for the current device may be included here.
205     * Implementations are not expected to be consistent across all devices.
206     * If no color effect modes are available for a device, this should
207     * simply be set to OFF.</p>
208     * <p>A color effect will only be applied if
209     * {@link CaptureRequest#CONTROL_MODE android.control.mode} != OFF.</p>
210     *
211     * @see CaptureRequest#CONTROL_EFFECT_MODE
212     * @see CaptureRequest#CONTROL_MODE
213     */
214    public static final Key<byte[]> CONTROL_AVAILABLE_EFFECTS =
215            new Key<byte[]>("android.control.availableEffects", byte[].class);
216
217    /**
218     * <p>List containing a subset of scene modes
219     * specified in {@link CaptureRequest#CONTROL_SCENE_MODE android.control.sceneMode}.</p>
220     * <p>This list contains scene modes that can be set for the camera device.
221     * Only scene modes that have been fully implemented for the
222     * camera device may be included here. Implementations are not expected
223     * to be consistent across all devices. If no scene modes are supported
224     * by the camera device, this will be set to <code>[DISABLED]</code>.</p>
225     *
226     * @see CaptureRequest#CONTROL_SCENE_MODE
227     */
228    public static final Key<byte[]> CONTROL_AVAILABLE_SCENE_MODES =
229            new Key<byte[]>("android.control.availableSceneModes", byte[].class);
230
231    /**
232     * <p>List of video stabilization modes that can
233     * be supported</p>
234     */
235    public static final Key<byte[]> CONTROL_AVAILABLE_VIDEO_STABILIZATION_MODES =
236            new Key<byte[]>("android.control.availableVideoStabilizationModes", byte[].class);
237
238    /**
239     * <p>The set of auto-white-balance modes ({@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode})
240     * that are supported by this camera device.</p>
241     * <p>Not all the auto-white-balance modes may be supported by a
242     * given camera device. This entry lists the valid modes for
243     * {@link CaptureRequest#CONTROL_AWB_MODE android.control.awbMode} for this camera device.</p>
244     * <p>All camera devices will support ON mode.</p>
245     * <p>Full-capability camera devices will always support OFF mode,
246     * which enables application control of white balance, by using
247     * {@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).</p>
248     *
249     * @see CaptureRequest#COLOR_CORRECTION_GAINS
250     * @see CaptureRequest#COLOR_CORRECTION_MODE
251     * @see CaptureRequest#COLOR_CORRECTION_TRANSFORM
252     * @see CaptureRequest#CONTROL_AWB_MODE
253     */
254    public static final Key<byte[]> CONTROL_AWB_AVAILABLE_MODES =
255            new Key<byte[]>("android.control.awbAvailableModes", byte[].class);
256
257    /**
258     * <p>List of the maximum number of regions that can be used for metering in
259     * auto-exposure (AE), auto-white balance (AWB), and auto-focus (AF);
260     * this corresponds to the the maximum number of elements in
261     * {@link CaptureRequest#CONTROL_AE_REGIONS android.control.aeRegions}, {@link CaptureRequest#CONTROL_AWB_REGIONS android.control.awbRegions},
262     * and {@link CaptureRequest#CONTROL_AF_REGIONS android.control.afRegions}.</p>
263     *
264     * @see CaptureRequest#CONTROL_AE_REGIONS
265     * @see CaptureRequest#CONTROL_AF_REGIONS
266     * @see CaptureRequest#CONTROL_AWB_REGIONS
267     */
268    public static final Key<int[]> CONTROL_MAX_REGIONS =
269            new Key<int[]>("android.control.maxRegions", int[].class);
270
271    /**
272     * <p>Whether this camera device has a
273     * flash.</p>
274     * <p>If no flash, none of the flash controls do
275     * anything. All other metadata should return 0.</p>
276     */
277    public static final Key<Boolean> FLASH_INFO_AVAILABLE =
278            new Key<Boolean>("android.flash.info.available", boolean.class);
279
280    /**
281     * <p>Supported resolutions for the JPEG thumbnail</p>
282     * <p>Below condiditions will be satisfied for this size list:</p>
283     * <ul>
284     * <li>The sizes will be sorted by increasing pixel area (width x height).
285     * If several resolutions have the same area, they will be sorted by increasing width.</li>
286     * <li>The aspect ratio of the largest thumbnail size will be same as the
287     * aspect ratio of largest size in {@link CameraCharacteristics#SCALER_AVAILABLE_JPEG_SIZES android.scaler.availableJpegSizes}.
288     * The largest size is defined as the size that has the largest pixel area
289     * in a given size list.</li>
290     * <li>Each size in {@link CameraCharacteristics#SCALER_AVAILABLE_JPEG_SIZES android.scaler.availableJpegSizes} will have at least
291     * one corresponding size that has the same aspect ratio in availableThumbnailSizes,
292     * and vice versa.</li>
293     * <li>All non (0, 0) sizes will have non-zero widths and heights.</li>
294     * </ul>
295     *
296     * @see CameraCharacteristics#SCALER_AVAILABLE_JPEG_SIZES
297     */
298    public static final Key<android.hardware.camera2.Size[]> JPEG_AVAILABLE_THUMBNAIL_SIZES =
299            new Key<android.hardware.camera2.Size[]>("android.jpeg.availableThumbnailSizes", android.hardware.camera2.Size[].class);
300
301    /**
302     * <p>List of supported aperture
303     * values.</p>
304     * <p>If the camera device doesn't support variable apertures,
305     * listed value will be the fixed aperture.</p>
306     * <p>If the camera device supports variable apertures, the aperture value
307     * in this list will be sorted in ascending order.</p>
308     */
309    public static final Key<float[]> LENS_INFO_AVAILABLE_APERTURES =
310            new Key<float[]>("android.lens.info.availableApertures", float[].class);
311
312    /**
313     * <p>List of supported neutral density filter values for
314     * {@link CaptureRequest#LENS_FILTER_DENSITY android.lens.filterDensity}.</p>
315     * <p>If changing {@link CaptureRequest#LENS_FILTER_DENSITY android.lens.filterDensity} is not supported,
316     * availableFilterDensities must contain only 0. Otherwise, this
317     * list contains only the exact filter density values available on
318     * this camera device.</p>
319     *
320     * @see CaptureRequest#LENS_FILTER_DENSITY
321     */
322    public static final Key<float[]> LENS_INFO_AVAILABLE_FILTER_DENSITIES =
323            new Key<float[]>("android.lens.info.availableFilterDensities", float[].class);
324
325    /**
326     * <p>The available focal lengths for this device for use with
327     * {@link CaptureRequest#LENS_FOCAL_LENGTH android.lens.focalLength}.</p>
328     * <p>If optical zoom is not supported, this will only report
329     * a single value corresponding to the static focal length of the
330     * device. Otherwise, this will report every focal length supported
331     * by the device.</p>
332     *
333     * @see CaptureRequest#LENS_FOCAL_LENGTH
334     */
335    public static final Key<float[]> LENS_INFO_AVAILABLE_FOCAL_LENGTHS =
336            new Key<float[]>("android.lens.info.availableFocalLengths", float[].class);
337
338    /**
339     * <p>List containing a subset of the optical image
340     * stabilization (OIS) modes specified in
341     * {@link CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE android.lens.opticalStabilizationMode}.</p>
342     * <p>If OIS is not implemented for a given camera device, this should
343     * contain only OFF.</p>
344     *
345     * @see CaptureRequest#LENS_OPTICAL_STABILIZATION_MODE
346     */
347    public static final Key<byte[]> LENS_INFO_AVAILABLE_OPTICAL_STABILIZATION =
348            new Key<byte[]>("android.lens.info.availableOpticalStabilization", byte[].class);
349
350    /**
351     * <p>Hyperfocal distance for this lens; set to
352     * 0 if fixed focus</p>
353     * <p>The hyperfocal distance is used for the old
354     * API's 'fixed' setting</p>
355     */
356    public static final Key<Float> LENS_INFO_HYPERFOCAL_DISTANCE =
357            new Key<Float>("android.lens.info.hyperfocalDistance", float.class);
358
359    /**
360     * <p>Shortest distance from frontmost surface
361     * of the lens that can be focused correctly</p>
362     * <p>If the lens is fixed-focus, this should be
363     * 0</p>
364     */
365    public static final Key<Float> LENS_INFO_MINIMUM_FOCUS_DISTANCE =
366            new Key<Float>("android.lens.info.minimumFocusDistance", float.class);
367
368    /**
369     * <p>Dimensions of lens shading map.</p>
370     * <p>The map should be on the order of 30-40 rows and columns, and
371     * must be smaller than 64x64.</p>
372     */
373    public static final Key<android.hardware.camera2.Size> LENS_INFO_SHADING_MAP_SIZE =
374            new Key<android.hardware.camera2.Size>("android.lens.info.shadingMapSize", android.hardware.camera2.Size.class);
375
376    /**
377     * <p>Direction the camera faces relative to
378     * device screen</p>
379     * @see #LENS_FACING_FRONT
380     * @see #LENS_FACING_BACK
381     */
382    public static final Key<Integer> LENS_FACING =
383            new Key<Integer>("android.lens.facing", int.class);
384
385    /**
386     * <p>If set to 1, the HAL will always split result
387     * metadata for a single capture into multiple buffers,
388     * returned using multiple process_capture_result calls.</p>
389     * <p>Does not need to be listed in static
390     * metadata. Support for partial results will be reworked in
391     * future versions of camera service. This quirk will stop
392     * working at that point; DO NOT USE without careful
393     * consideration of future support.</p>
394     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
395     * @hide
396     */
397    public static final Key<Byte> QUIRKS_USE_PARTIAL_RESULT =
398            new Key<Byte>("android.quirks.usePartialResult", byte.class);
399
400    /**
401     * <p>The maximum numbers of different types of output streams
402     * that can be configured and used simultaneously by a camera device.</p>
403     * <p>This is a 3 element tuple that contains the max number of output simultaneous
404     * streams for raw sensor, processed (and uncompressed), and JPEG formats respectively.
405     * For example, if max raw sensor format output stream number is 1, max YUV streams
406     * number is 3, and max JPEG stream number is 2, then this tuple should be <code>(1, 3, 2)</code>.</p>
407     * <p>This lists the upper bound of the number of output streams supported by
408     * the camera device. Using more streams simultaneously may require more hardware and
409     * CPU resources that will consume more power. The image format for a output stream can
410     * be any supported format provided by {@link CameraCharacteristics#SCALER_AVAILABLE_FORMATS android.scaler.availableFormats}. The formats
411     * defined in {@link CameraCharacteristics#SCALER_AVAILABLE_FORMATS android.scaler.availableFormats} can be catergorized into the 3 stream types
412     * as below:</p>
413     * <ul>
414     * <li>JPEG-compressed format: BLOB.</li>
415     * <li>Raw formats: RAW_SENSOR and RAW_OPAQUE.</li>
416     * <li>processed, uncompressed formats: YCbCr_420_888, YCrCb_420_SP, YV12.</li>
417     * </ul>
418     *
419     * @see CameraCharacteristics#SCALER_AVAILABLE_FORMATS
420     */
421    public static final Key<int[]> REQUEST_MAX_NUM_OUTPUT_STREAMS =
422            new Key<int[]>("android.request.maxNumOutputStreams", int[].class);
423
424    /**
425     * <p>The maximum numbers of any type of input streams
426     * that can be configured and used simultaneously by a camera device.</p>
427     * <p>When set to 0, it means no input stream is supported.</p>
428     * <p>The image format for a input stream can be any supported format provided
429     * by android.scaler.availableInputFormats. When using an input stream, there must be
430     * at least one output stream configured to to receive the reprocessed images.</p>
431     * <p>For example, for Zero Shutter Lag (ZSL) still capture use case, the input
432     * stream image format will be RAW_OPAQUE, the associated output stream image format
433     * should be JPEG.</p>
434     */
435    public static final Key<Integer> REQUEST_MAX_NUM_INPUT_STREAMS =
436            new Key<Integer>("android.request.maxNumInputStreams", int.class);
437
438    /**
439     * <p>Specifies the number of maximum pipeline stages a frame
440     * has to go through from when it's exposed to when it's available
441     * to the framework.</p>
442     * <p>A typical minimum value for this is 2 (one stage to expose,
443     * one stage to readout) from the sensor. The ISP then usually adds
444     * its own stages to do custom HW processing. Further stages may be
445     * added by SW processing.</p>
446     * <p>Depending on what settings are used (e.g. YUV, JPEG) and what
447     * processing is enabled (e.g. face detection), the actual pipeline
448     * depth (specified by {@link CaptureResult#REQUEST_PIPELINE_DEPTH android.request.pipelineDepth}) may be less than
449     * the max pipeline depth.</p>
450     * <p>A pipeline depth of X stages is equivalent to a pipeline latency of
451     * X frame intervals.</p>
452     * <p>This value will be 8 or less.</p>
453     *
454     * @see CaptureResult#REQUEST_PIPELINE_DEPTH
455     */
456    public static final Key<Byte> REQUEST_PIPELINE_MAX_DEPTH =
457            new Key<Byte>("android.request.pipelineMaxDepth", byte.class);
458
459    /**
460     * <p>Optional. Defaults to 1. Defines how many sub-components
461     * a result will be composed of.</p>
462     * <p>In order to combat the pipeline latency, partial results
463     * may be delivered to the application layer from the camera device as
464     * soon as they are available.</p>
465     * <p>A value of 1 means that partial results are not supported.</p>
466     * <p>A typical use case for this might be: after requesting an AF lock the
467     * new AF state might be available 50% of the way through the pipeline.
468     * The camera device could then immediately dispatch this state via a
469     * partial result to the framework/application layer, and the rest of
470     * the metadata via later partial results.</p>
471     */
472    public static final Key<Integer> REQUEST_PARTIAL_RESULT_COUNT =
473            new Key<Integer>("android.request.partialResultCount", int.class);
474
475    /**
476     * <p>The list of image formats that are supported by this
477     * camera device.</p>
478     * <p>All camera devices will support JPEG and YUV_420_888 formats.</p>
479     * <p>When set to YUV_420_888, application can access the YUV420 data directly.</p>
480     */
481    public static final Key<int[]> SCALER_AVAILABLE_FORMATS =
482            new Key<int[]>("android.scaler.availableFormats", int[].class);
483
484    /**
485     * <p>The minimum frame duration that is supported
486     * for each resolution in {@link CameraCharacteristics#SCALER_AVAILABLE_JPEG_SIZES android.scaler.availableJpegSizes}.</p>
487     * <p>This corresponds to the minimum steady-state frame duration when only
488     * that JPEG stream is active and captured in a burst, with all
489     * processing (typically in android.*.mode) set to FAST.</p>
490     * <p>When multiple streams are configured, the minimum
491     * frame duration will be &gt;= max(individual stream min
492     * durations)</p>
493     *
494     * @see CameraCharacteristics#SCALER_AVAILABLE_JPEG_SIZES
495     */
496    public static final Key<long[]> SCALER_AVAILABLE_JPEG_MIN_DURATIONS =
497            new Key<long[]>("android.scaler.availableJpegMinDurations", long[].class);
498
499    /**
500     * <p>The JPEG resolutions that are supported by this camera device.</p>
501     * <p>The resolutions are listed as <code>(width, height)</code> pairs. All camera devices will support
502     * sensor maximum resolution (defined by {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize}).</p>
503     *
504     * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE
505     */
506    public static final Key<android.hardware.camera2.Size[]> SCALER_AVAILABLE_JPEG_SIZES =
507            new Key<android.hardware.camera2.Size[]>("android.scaler.availableJpegSizes", android.hardware.camera2.Size[].class);
508
509    /**
510     * <p>The maximum ratio between active area width
511     * and crop region width, or between active area height and
512     * crop region height, if the crop region height is larger
513     * than width</p>
514     */
515    public static final Key<Float> SCALER_AVAILABLE_MAX_DIGITAL_ZOOM =
516            new Key<Float>("android.scaler.availableMaxDigitalZoom", float.class);
517
518    /**
519     * <p>For each available processed output size (defined in
520     * {@link CameraCharacteristics#SCALER_AVAILABLE_PROCESSED_SIZES android.scaler.availableProcessedSizes}), this property lists the
521     * minimum supportable frame duration for that size.</p>
522     * <p>This should correspond to the frame duration when only that processed
523     * stream is active, with all processing (typically in android.*.mode)
524     * set to FAST.</p>
525     * <p>When multiple streams are configured, the minimum frame duration will
526     * be &gt;= max(individual stream min durations).</p>
527     *
528     * @see CameraCharacteristics#SCALER_AVAILABLE_PROCESSED_SIZES
529     */
530    public static final Key<long[]> SCALER_AVAILABLE_PROCESSED_MIN_DURATIONS =
531            new Key<long[]>("android.scaler.availableProcessedMinDurations", long[].class);
532
533    /**
534     * <p>The resolutions available for use with
535     * processed output streams, such as YV12, NV12, and
536     * platform opaque YUV/RGB streams to the GPU or video
537     * encoders.</p>
538     * <p>The resolutions are listed as <code>(width, height)</code> pairs.</p>
539     * <p>For a given use case, the actual maximum supported resolution
540     * may be lower than what is listed here, depending on the destination
541     * Surface for the image data. For example, for recording video,
542     * the video encoder chosen may have a maximum size limit (e.g. 1080p)
543     * smaller than what the camera (e.g. maximum resolution is 3264x2448)
544     * can provide.</p>
545     * <p>Please reference the documentation for the image data destination to
546     * check if it limits the maximum size for image data.</p>
547     */
548    public static final Key<android.hardware.camera2.Size[]> SCALER_AVAILABLE_PROCESSED_SIZES =
549            new Key<android.hardware.camera2.Size[]>("android.scaler.availableProcessedSizes", android.hardware.camera2.Size[].class);
550
551    /**
552     * <p>Area of raw data which corresponds to only
553     * active pixels.</p>
554     * <p>It is smaller or equal to
555     * sensor full pixel array, which could include the black calibration pixels.</p>
556     */
557    public static final Key<android.graphics.Rect> SENSOR_INFO_ACTIVE_ARRAY_SIZE =
558            new Key<android.graphics.Rect>("android.sensor.info.activeArraySize", android.graphics.Rect.class);
559
560    /**
561     * <p>Range of valid sensitivities</p>
562     */
563    public static final Key<int[]> SENSOR_INFO_SENSITIVITY_RANGE =
564            new Key<int[]>("android.sensor.info.sensitivityRange", int[].class);
565
566    /**
567     * <p>Range of valid exposure
568     * times used by {@link CaptureRequest#SENSOR_EXPOSURE_TIME android.sensor.exposureTime}.</p>
569     *
570     * @see CaptureRequest#SENSOR_EXPOSURE_TIME
571     */
572    public static final Key<long[]> SENSOR_INFO_EXPOSURE_TIME_RANGE =
573            new Key<long[]>("android.sensor.info.exposureTimeRange", long[].class);
574
575    /**
576     * <p>Maximum possible frame duration (minimum frame
577     * rate).</p>
578     * <p>The largest possible android.sensor.frameDuration
579     * that will be accepted by the camera device. Attempting to use
580     * frame durations beyond the maximum will result in the frame duration
581     * being clipped to the maximum. See that control
582     * for a full definition of frame durations.</p>
583     * <p>Refer to
584     * {@link CameraCharacteristics#SCALER_AVAILABLE_PROCESSED_MIN_DURATIONS android.scaler.availableProcessedMinDurations},
585     * {@link CameraCharacteristics#SCALER_AVAILABLE_JPEG_MIN_DURATIONS android.scaler.availableJpegMinDurations}, and
586     * android.scaler.availableRawMinDurations for the minimum
587     * frame duration values.</p>
588     *
589     * @see CameraCharacteristics#SCALER_AVAILABLE_JPEG_MIN_DURATIONS
590     * @see CameraCharacteristics#SCALER_AVAILABLE_PROCESSED_MIN_DURATIONS
591     */
592    public static final Key<Long> SENSOR_INFO_MAX_FRAME_DURATION =
593            new Key<Long>("android.sensor.info.maxFrameDuration", long.class);
594
595    /**
596     * <p>The physical dimensions of the full pixel
597     * array</p>
598     * <p>Needed for FOV calculation for old API</p>
599     */
600    public static final Key<float[]> SENSOR_INFO_PHYSICAL_SIZE =
601            new Key<float[]>("android.sensor.info.physicalSize", float[].class);
602
603    /**
604     * <p>Gain factor from electrons to raw units when
605     * ISO=100</p>
606     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
607     * <p><b>Full capability</b> -
608     * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
609     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
610     *
611     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
612     */
613    public static final Key<Rational> SENSOR_BASE_GAIN_FACTOR =
614            new Key<Rational>("android.sensor.baseGainFactor", Rational.class);
615
616    /**
617     * <p>A fixed black level offset for each of the color filter arrangement
618     * (CFA) mosaic channels.</p>
619     * <p>This tag specifies the zero light value for each of the CFA mosaic
620     * channels in the camera sensor.</p>
621     * <p>The values are given in row-column scan order, with the first value
622     * corresponding to the element of the CFA in row=0, column=0.</p>
623     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
624     */
625    public static final Key<int[]> SENSOR_BLACK_LEVEL_PATTERN =
626            new Key<int[]>("android.sensor.blackLevelPattern", int[].class);
627
628    /**
629     * <p>Maximum sensitivity that is implemented
630     * purely through analog gain.</p>
631     * <p>For {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity} values less than or
632     * equal to this, all applied gain must be analog. For
633     * values above this, the gain applied can be a mix of analog and
634     * digital.</p>
635     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
636     * <p><b>Full capability</b> -
637     * Present on all camera devices that report being {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_FULL HARDWARE_LEVEL_FULL} devices in the
638     * {@link CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL android.info.supportedHardwareLevel} key</p>
639     *
640     * @see CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
641     * @see CaptureRequest#SENSOR_SENSITIVITY
642     */
643    public static final Key<Integer> SENSOR_MAX_ANALOG_SENSITIVITY =
644            new Key<Integer>("android.sensor.maxAnalogSensitivity", int.class);
645
646    /**
647     * <p>Clockwise angle through which the output
648     * image needs to be rotated to be upright on the device
649     * screen in its native orientation. Also defines the
650     * direction of rolling shutter readout, which is from top
651     * to bottom in the sensor's coordinate system</p>
652     */
653    public static final Key<Integer> SENSOR_ORIENTATION =
654            new Key<Integer>("android.sensor.orientation", int.class);
655
656    /**
657     * <p>Optional. Defaults to [OFF]. Lists the supported test
658     * pattern modes for android.test.patternMode.</p>
659     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>
660     */
661    public static final Key<Byte> SENSOR_AVAILABLE_TEST_PATTERN_MODES =
662            new Key<Byte>("android.sensor.availableTestPatternModes", byte.class);
663
664    /**
665     * <p>Which face detection modes are available,
666     * if any</p>
667     * <p>OFF means face detection is disabled, it must
668     * be included in the list.</p>
669     * <p>SIMPLE means the device supports the
670     * android.statistics.faceRectangles and
671     * android.statistics.faceScores outputs.</p>
672     * <p>FULL means the device additionally supports the
673     * android.statistics.faceIds and
674     * android.statistics.faceLandmarks outputs.</p>
675     */
676    public static final Key<byte[]> STATISTICS_INFO_AVAILABLE_FACE_DETECT_MODES =
677            new Key<byte[]>("android.statistics.info.availableFaceDetectModes", byte[].class);
678
679    /**
680     * <p>Maximum number of simultaneously detectable
681     * faces</p>
682     */
683    public static final Key<Integer> STATISTICS_INFO_MAX_FACE_COUNT =
684            new Key<Integer>("android.statistics.info.maxFaceCount", int.class);
685
686    /**
687     * <p>Maximum number of supported points in the
688     * tonemap curve that can be used for {@link CaptureRequest#TONEMAP_CURVE_RED android.tonemap.curveRed}, or
689     * {@link CaptureRequest#TONEMAP_CURVE_GREEN android.tonemap.curveGreen}, or {@link CaptureRequest#TONEMAP_CURVE_BLUE android.tonemap.curveBlue}.</p>
690     * <p>If the actual number of points provided by the application (in
691     * android.tonemap.curve*)  is less than max, the camera device will
692     * resample the curve to its internal representation, using linear
693     * interpolation.</p>
694     * <p>The output curves in the result metadata may have a different number
695     * of points than the input curves, and will represent the actual
696     * hardware curves used as closely as possible when linearly interpolated.</p>
697     *
698     * @see CaptureRequest#TONEMAP_CURVE_BLUE
699     * @see CaptureRequest#TONEMAP_CURVE_GREEN
700     * @see CaptureRequest#TONEMAP_CURVE_RED
701     */
702    public static final Key<Integer> TONEMAP_MAX_CURVE_POINTS =
703            new Key<Integer>("android.tonemap.maxCurvePoints", int.class);
704
705    /**
706     * <p>A list of camera LEDs that are available on this system.</p>
707     * @see #LED_AVAILABLE_LEDS_TRANSMIT
708     * @hide
709     */
710    public static final Key<int[]> LED_AVAILABLE_LEDS =
711            new Key<int[]>("android.led.availableLeds", int[].class);
712
713    /**
714     * <p>The camera 3 HAL device can implement one of two possible
715     * operational modes; limited and full. Full support is
716     * expected from new higher-end devices. Limited mode has
717     * hardware requirements roughly in line with those for a
718     * camera HAL device v1 implementation, and is expected from
719     * older or inexpensive devices. Full is a strict superset of
720     * limited, and they share the same essential operational flow.</p>
721     * <p>For full details refer to "S3. Operational Modes" in camera3.h</p>
722     * @see #INFO_SUPPORTED_HARDWARE_LEVEL_LIMITED
723     * @see #INFO_SUPPORTED_HARDWARE_LEVEL_FULL
724     */
725    public static final Key<Integer> INFO_SUPPORTED_HARDWARE_LEVEL =
726            new Key<Integer>("android.info.supportedHardwareLevel", int.class);
727
728    /**
729     * <p>The maximum number of frames that can occur after a request
730     * (different than the previous) has been submitted, and before the
731     * result's state becomes synchronized (by setting
732     * android.sync.frameNumber to a non-negative value).</p>
733     * <p>This defines the maximum distance (in number of metadata results),
734     * between android.sync.frameNumber and the equivalent
735     * android.request.frameCount.</p>
736     * <p>In other words this acts as an upper boundary for how many frames
737     * must occur before the camera device knows for a fact that the new
738     * submitted camera settings have been applied in outgoing frames.</p>
739     * <p>For example if the distance was 2,</p>
740     * <pre><code>initial request = X (repeating)
741     * request1 = X
742     * request2 = Y
743     * request3 = Y
744     * request4 = Y
745     *
746     * where requestN has frameNumber N, and the first of the repeating
747     * initial request's has frameNumber F (and F &lt; 1).
748     *
749     * initial result = X' + { android.sync.frameNumber == F }
750     * result1 = X' + { android.sync.frameNumber == F }
751     * result2 = X' + { android.sync.frameNumber == CONVERGING }
752     * result3 = X' + { android.sync.frameNumber == CONVERGING }
753     * result4 = X' + { android.sync.frameNumber == 2 }
754     *
755     * where resultN has frameNumber N.
756     * </code></pre>
757     * <p>Since <code>result4</code> has a <code>frameNumber == 4</code> and
758     * <code>android.sync.frameNumber == 2</code>, the distance is clearly
759     * <code>4 - 2 = 2</code>.</p>
760     * @see #SYNC_MAX_LATENCY_PER_FRAME_CONTROL
761     * @see #SYNC_MAX_LATENCY_UNKNOWN
762     */
763    public static final Key<Integer> SYNC_MAX_LATENCY =
764            new Key<Integer>("android.sync.maxLatency", int.class);
765
766    /*~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~
767     * End generated code
768     *~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~@~O@*/
769}
770